• Array of: object schema
  An account.

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

• accountFirstName: string
  The account owner's first name.
• accountLastName: string
  The account owner's last name.
• accountNumber(required): string
  The account number.
• balanceGroupRef: object ResourceRef
• billUnit(required): array billUnit
  A bill unit.
• businessType: string
  The account's business type: 1 (consumer) or 2 (business).
• contacts(required): array contacts
  An account's contact information.
• creationDate(required): string (date-time)
  The date and time the account was created.
• currency: integer (int32)
  The code for the account's primary currency.
• currencySecondary: integer (int32)
  The account's secondary currency.
• customerDurationDays: integer (int32)
  The number of days that the account has been a customer.
• customerDurationYears: integer (int32)
  The number of years that the account has been a customer.
• customerTypeCode: integer (int32)
  The customer type: 1 (standard), 2 (brand), or 3 (subscription).
• extension: object extension
  The extended attributes.
• id(required): string
  The ID.
• locale: string
  The customer's locale, such as en_US or fr_FR. For a list of valid values, see "Locale Names" in BRM Developer's Guide.
• organizationHierarchyTypeCode: integer (int32)
  The internal code for the account's organization hierarchy type.
• parentRef: object ResourceRef
• pendingDeferredActionsCount: integer (int32)
  The number of deferred actions in pending state.
• securityCode1: string
  The first access code for voice verification.
• securityCode2: string
  The second access code for voice verification.
• statusCode: integer (int32)
  The code for the account's status: 0 (defunct), 10100 (active), 10102 (inactive), or 10103 (closed).
• timezoneId: string
  The ID of the account's time zone.
• wallet: object Wallet

{
    "required":[
        "accountNumber",
        "billUnit",
        "contacts",
        "creationDate",
        "id"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the account was created.",
            "format":"date-time"
        },
        "pendingDeferredActionsCount":{
            "type":"integer",
            "description":"The number of deferred actions in pending state.",
            "format":"int32"
        },
        "customerDurationDays":{
            "type":"integer",
            "description":"The number of days that the account has been a customer.",
            "format":"int32"
        },
        "customerDurationYears":{
            "type":"integer",
            "description":"The number of years that the account has been a customer.",
            "format":"int32"
        },
        "accountNumber":{
            "type":"string",
            "description":"The account number."
        },
        "accountFirstName":{
            "type":"string",
            "description":"The account owner's first name."
        },
        "accountLastName":{
            "type":"string",
            "description":"The account owner's last name."
        },
        "securityCode1":{
            "type":"string",
            "description":"The first access code for voice verification."
        },
        "securityCode2":{
            "type":"string",
            "description":"The second access code for voice verification."
        },
        "currency":{
            "type":"integer",
            "description":"The code for the account's primary currency.",
            "format":"int32"
        },
        "currencySecondary":{
            "type":"integer",
            "description":"The account's secondary currency.",
            "format":"int32"
        },
        "locale":{
            "type":"string",
            "description":"The customer's locale, such as <b>en_US</b> or <b>fr_FR</b>. For a list of valid values, see \"Locale Names\" in <i>BRM Developer's Guide</i>."
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "customerTypeCode":{
            "type":"integer",
            "description":"The customer type: <b>1</b> (standard), <b>2</b> (brand), or <b>3</b> (subscription).",
            "format":"int32"
        },
        "organizationHierarchyTypeCode":{
            "type":"integer",
            "description":"The internal code for the account's organization hierarchy type.",
            "format":"int32"
        },
        "businessType":{
            "type":"string",
            "description":"The account's business type: <b>1</b> (consumer) or <b>2</b> (business)."
        },
        "parentRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "contacts":{
            "type":"array",
            "description":"An account's contact information.",
            "items":{
                "$ref":"#/components/schemas/Contacts"
            }
        },
        "statusCode":{
            "type":"integer",
            "description":"The code for the account's status: <b>0</b> (defunct), <b>10100</b> (active), <b>10102</b> (inactive), or <b>10103</b> (closed).",
            "format":"int32"
        },
        "timezoneId":{
            "type":"string",
            "description":"The ID of the account's time zone."
        },
        "wallet":{
            "$ref":"#/components/schemas/Wallet"
        },
        "billUnit":{
            "type":"array",
            "description":"A bill unit.",
            "items":{
                "$ref":"#/components/schemas/BillUnit"
            }
        }
    },
    "description":"An account.",
    "xml":{
        "name":"account"
    }
}

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

• Array of: object schema
  A bill unit.

{
    "type":"array",
    "description":"A bill unit.",
    "items":{
        "$ref":"#/components/schemas/BillUnit"
    }
}

• Array of: object contacts
  An account's contact information.

{
    "type":"array",
    "description":"An account's contact information.",
    "items":{
        "$ref":"#/components/schemas/Contacts"
    }
}

• extension: object extension
  The extended attributes.
• paymentInstrument: array paymentInstrument

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "paymentInstrument":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"object",
                        "properties":{
                            "namespaceURI":{
                                "type":"string"
                            },
                            "localPart":{
                                "type":"string"
                            },
                            "prefix":{
                                "type":"string"
                            }
                        }
                    },
                    "value":{
                        "$ref":"#/components/schemas/PaymentInstrumentType"
                    },
                    "nil":{
                        "type":"boolean"
                    },
                    "globalScope":{
                        "type":"boolean"
                    },
                    "typeSubstituted":{
                        "type":"boolean"
                    }
                }
            }
        }
    }
}

• accountingCycleDom: integer (int32)
  The bill unit's accounting cycle day of month (DOM).
• accountingCycleEnd: string (date-time)
  The date and time the accounting cycle ends.
• accountingCycleStart: string (date-time)
  The date and time the accounting cycle starts.
• accountingCyclesUntilBillCycleEnds: integer (int32)
  The number of monthly accounting cycles remaining until the current billing cycle ends.
• accountingType: integer (int32)
  The bill unit's accounting type: open item (1) or balance forward (2).
• accountRef: object ResourceRef
• arBillUnitRef: object ResourceRef
• balanceGroups(required): array balanceGroups
• bdomChangeStatus: integer (int32)
  The status of the billing day-of-month (DOM) change. Can be one of the following:

  • -1: Does not exist
  • 0: New
  • 1: In progress
  • 2: Failed
  • 3: Completed
• bdomJobCompletion: string (date-time)
  The time the billing day-of-month (DOM) change job was completed, if applicable.
• bdomJobFlag: integer (int32)
  Whether the billing day of month (DOM) changes for member accounts should be executed immediately (1) or deferred (2). This flag applies only to parent accounts' bill units that have a business profile with the AsyncBDOMChange key set to yes. If a value is not sent, the job will be deferred (as with a value of 2).
• billForCurrentCycleRef: object ResourceRef
• billingCycleEnd: string (date-time)
  The date and time the billing cycle ends.
• billingCycleStart: string (date-time)
  The date and time the billing cycle starts
• billingFrequencyInMonths: integer (int32)
  The billing frequency in number of months. Can be one of the following:

  • 1: Monthly
  • 2: Bi-monthly
  • 3: Quarterly
  • 12: Yearly
• businessProfile(required): string
  The business profile associated with bill unit.
• collectionDate: string (date-time)
  The date collections is due.
• collectionDetailsRef: object ResourceRef
• correctiveInvoiceType: integer (int32)
  The type of invoice to create for corrective bills, such as an invoice correction letter or a replacement invoice.
• creationDate(required): string (date-time)
  The date and time the bill unit was created.
• currency: integer (int32)
  The bill unit's primary currency.
• currencySecondary: integer (int32)
  The bill unit's secondary currency.
• daysInBillCycle: integer (int32)
  The number of days in a billing cycle.
• daysRemainingInBillCycle: integer (int32)
  The number of days that remain in the current billing cycle.
• defaultBillUnit: boolean
  Whether this is the default bill unit (true) or not (false).
• exemptFromCollections: integer (int32)
  Whether the bill unit is exempt from collections or not.
• extension: object extension
  The extended attributes.
• id(required): string
  The ID.
• inCollections: boolean
  Whether the bill unit is in collections (true) or not (false).
• invoiceTemplate(required): string
  The name of the invoice template associated with the bill unit.
• lastActualBillDate: string (date-time)
  The date and time the last bill was created.
• lastActualBillRef: object ResourceRef
• lastBillFromBillingRef: object ResourceRef
• lastModified: string (date-time)
  The date and time the bill unit was last modified.
• name(required): string
  The bill unit's name.
• numSuppressedCycles: integer (int32)
  The number of consecutive billing cycles that the bill unit has been suppressed.
• parentAccountId(required): string
  The ID of this bill unit's parent account.
• parentAccountNumber(required): string
  The account number associated with the parent's bill unit.
• parentBillUnit: boolean
  Whether this is a parent bill unit (true) or not (false).
• parentBillUnitName(required): string
  The name of this bill unit's parent bill unit.
• parentCompanyName(required): string
  The parent bill unit's company name.
• parentFirstName(required): string
  The first name associated with the parent bill unit.
• parentLastName(required): string
  The last name associated with the parent bill unit.
• parentSalutation(required): string
  The parent bill unit's salutation, such as Mr. or Mx.
• paymentInstrumentName(required): string
  The name of the payment instrument.
• paymentInstrumentRef: object ResourceRef
• paymentMethod: object PaymentMethod
• paymentType: integer (int32)
  The payment type. Can be one of the following:

  • 10001:Invoice
  • 10003: Credit card
  • 10005: Direct debit
  • 10007: Subordinate
• rollUp: boolean
• scenarioRef: object ResourceRef
• segment: string
  The customer segment associated with the bill unit. A customer segment is a user-defined customer description that can be used to group accounts according to customer billing and payment practices.
• status: string
  The status of the bill unit: defunct (0), active (10100), inactive (10102), or closed (10103)
• suppressed: integer (int32)
  Whether the bill unit is suppressed or not.
• suppressionCyclesLeft: integer (int32)
  The number of consecutive billing cycles for which the bill is to be suppressed.
• totalChildAccounts: integer (int32)
  The total number of child accounts.
• totalChildBillUnits: integer (int32)
  The total number of child bill units.
• wholesaleBilling(required): string
  The wholesale billing key.

{
    "required":[
        "balanceGroups",
        "businessProfile",
        "creationDate",
        "id",
        "invoiceTemplate",
        "name",
        "parentAccountId",
        "parentAccountNumber",
        "parentBillUnitName",
        "parentCompanyName",
        "parentFirstName",
        "parentLastName",
        "parentSalutation",
        "paymentInstrumentName",
        "wholesaleBilling"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The bill unit's name."
        },
        "rollUp":{
            "type":"boolean"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "bdomJobFlag":{
            "type":"integer",
            "description":"Whether the billing day of month (DOM) changes for member accounts should be executed immediately (<b>1</b>) or deferred (<b>2</b>). This flag applies only to parent accounts' bill units that have a business profile with the <b>AsyncBDOMChange</b> key set to <b>yes</b>. If a value is not sent, the job will be deferred (as with a value of <b>2</b>).",
            "format":"int32"
        },
        "accountingCycleDom":{
            "type":"integer",
            "description":"The bill unit's accounting cycle day of month (DOM).",
            "format":"int32"
        },
        "bdomJobCompletion":{
            "type":"string",
            "description":"The time the billing day-of-month (DOM) change job was completed, if applicable.",
            "format":"date-time"
        },
        "bdomChangeStatus":{
            "type":"integer",
            "description":"The status of the billing day-of-month (DOM) change. Can be one of the following:<ul><li><b>-1</b>: Does not exist</li><li><b>0</b>: New</li><li><b>1</b>: In progress</li><li><b>2</b>: Failed</li><li><b>3</b>: Completed</li></ul>",
            "format":"int32"
        },
        "accountingType":{
            "type":"integer",
            "description":"The bill unit's accounting type: open item (<b>1</b>) or balance forward (<b>2</b>).",
            "format":"int32"
        },
        "balanceGroups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BalanceGroup"
            }
        },
        "paymentInstrumentRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "currency":{
            "type":"integer",
            "description":"The bill unit's primary currency.",
            "format":"int32"
        },
        "currencySecondary":{
            "type":"integer",
            "description":"The bill unit's secondary currency.",
            "format":"int32"
        },
        "status":{
            "type":"string",
            "description":"The status of the bill unit: defunct (<b>0</b>), active (<b>10100</b>), inactive (<b>10102</b>), or closed (<b>10103</b>)"
        },
        "arBillUnitRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "parentBillUnitName":{
            "type":"string",
            "description":"The name of this bill unit's parent bill unit."
        },
        "parentAccountId":{
            "type":"string",
            "description":"The ID of this bill unit's parent account."
        },
        "parentFirstName":{
            "type":"string",
            "description":"The first name associated with the parent bill unit."
        },
        "parentLastName":{
            "type":"string",
            "description":"The last name associated with the parent bill unit."
        },
        "parentCompanyName":{
            "type":"string",
            "description":"The parent bill unit's company name."
        },
        "parentSalutation":{
            "type":"string",
            "description":"The parent bill unit's salutation, such as Mr. or Mx."
        },
        "parentAccountNumber":{
            "type":"string",
            "description":"The account number associated with the parent's bill unit."
        },
        "invoiceTemplate":{
            "type":"string",
            "description":"The name of the invoice template associated with the bill unit."
        },
        "businessProfile":{
            "type":"string",
            "description":"The business profile associated with bill unit."
        },
        "wholesaleBilling":{
            "type":"string",
            "description":"The wholesale billing key."
        },
        "correctiveInvoiceType":{
            "type":"integer",
            "description":"The type of invoice to create for corrective bills, such as an invoice correction letter or a replacement invoice.",
            "format":"int32"
        },
        "lastModified":{
            "type":"string",
            "description":"The date and time the bill unit was last modified.",
            "format":"date-time"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the bill unit was created.",
            "format":"date-time"
        },
        "accountingCyclesUntilBillCycleEnds":{
            "type":"integer",
            "description":"The number of monthly accounting cycles remaining until the current billing cycle ends.",
            "format":"int32"
        },
        "billForCurrentCycleRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "defaultBillUnit":{
            "type":"boolean",
            "description":"Whether this is the default bill unit (<b>true</b>) or not (<b>false</b>)."
        },
        "parentBillUnit":{
            "type":"boolean",
            "description":"Whether this is a parent bill unit (<b>true</b>) or not (<b>false</b>)."
        },
        "billingFrequencyInMonths":{
            "type":"integer",
            "description":"The billing frequency in number of months. Can be one of the following: <ul><li><b>1</b>: Monthly</li><li><b>2</b>: Bi-monthly</li><li><b>3</b>: Quarterly</li><li><b>12</b>: Yearly</li></ul>",
            "format":"int32"
        },
        "accountingCycleStart":{
            "type":"string",
            "description":"The date and time the accounting cycle starts.",
            "format":"date-time"
        },
        "accountingCycleEnd":{
            "type":"string",
            "description":"The date and time the accounting cycle ends.",
            "format":"date-time"
        },
        "lastActualBillRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "lastActualBillDate":{
            "type":"string",
            "description":"The date and time the last bill was created.",
            "format":"date-time"
        },
        "lastBillFromBillingRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billingCycleStart":{
            "type":"string",
            "description":"The date and time the billing cycle starts",
            "format":"date-time"
        },
        "billingCycleEnd":{
            "type":"string",
            "description":"The date and time the billing cycle ends.",
            "format":"date-time"
        },
        "segment":{
            "type":"string",
            "description":"The customer segment associated with the bill unit. A customer segment is a user-defined customer description that can be used to group accounts according to customer billing and payment practices."
        },
        "daysInBillCycle":{
            "type":"integer",
            "description":"The number of days in a billing cycle.",
            "format":"int32"
        },
        "daysRemainingInBillCycle":{
            "type":"integer",
            "description":"The number of days that remain in the current billing cycle.",
            "format":"int32"
        },
        "exemptFromCollections":{
            "type":"integer",
            "description":"Whether the bill unit is exempt from collections or not.",
            "format":"int32"
        },
        "scenarioRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "numSuppressedCycles":{
            "type":"integer",
            "description":"The number of consecutive billing cycles that the bill unit has been suppressed.",
            "format":"int32"
        },
        "suppressed":{
            "type":"integer",
            "description":"Whether the bill unit is suppressed or not.",
            "format":"int32"
        },
        "suppressionCyclesLeft":{
            "type":"integer",
            "description":"The number of consecutive billing cycles for which the bill is to be suppressed.",
            "format":"int32"
        },
        "collectionDate":{
            "type":"string",
            "description":"The date collections is due.",
            "format":"date-time"
        },
        "paymentInstrumentName":{
            "type":"string",
            "description":"The name of the payment instrument."
        },
        "collectionDetailsRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "inCollections":{
            "type":"boolean",
            "description":"Whether the bill unit is in collections (<b>true</b>) or not (<b>false</b>)."
        },
        "paymentMethod":{
            "$ref":"#/components/schemas/PaymentMethod"
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "totalChildAccounts":{
            "type":"integer",
            "description":"The total number of child accounts.",
            "format":"int32"
        },
        "totalChildBillUnits":{
            "type":"integer",
            "description":"The total number of child bill units.",
            "format":"int32"
        }
    },
    "description":"A bill unit.",
    "xml":{
        "name":"billUnit"
    }
}

• Array of: object BalanceGroup

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

• creditCard: object CreditCardType
• directDebit: object DirectDebitType
• extension: object extension
  The extended attributes.
• invoice: object InvoiceType
• paymentType: integer (int32)
  The payment type. Can be one of the following:

  • 10001:Invoice
  • 10003: Credit card
  • 10005: Direct debit
  • 10007: Subordinate
• sepa: object SepaType

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "creditCard":{
            "$ref":"#/components/schemas/CreditCardType"
        },
        "directDebit":{
            "$ref":"#/components/schemas/DirectDebitType"
        },
        "invoice":{
            "$ref":"#/components/schemas/InvoiceType"
        },
        "sepa":{
            "$ref":"#/components/schemas/SepaType"
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        }
    }
}

• balances: array balances
  The list of balances associated with the balance group.
• elem: integer (int32)
  The position of the entry in the array. For example, the first item in a list would have an elem value of 1.
• extension: object extension
  The extended attributes.
• id(required): string
  The ID.
• monitorType: string
  The monitoring group type. Allowed Values:

  • H_CE (Hierarchy Credit Exposure)
  • PR_CE (Payment Responsible Credit Exposure)
  • SUB_CE (Subscription Credit Exposure)
  • PR_RTCE (Payment Responsible Real-Time Credit Enforcement)
• name: string
  The name of the balance group.
• services: array services

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The name of the balance group."
        },
        "services":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceType"
            }
        },
        "monitorType":{
            "type":"string",
            "description":"The monitoring group type. Allowed Values: <ul><li><b>H_CE</b> (Hierarchy Credit Exposure)</li><li><b>PR_CE</b> (Payment Responsible Credit Exposure)</li><li><b>SUB_CE</b> (Subscription Credit Exposure)</li><li><b>PR_RTCE</b> (Payment Responsible Real-Time Credit Enforcement)</li></ul>"
        },
        "balances":{
            "type":"array",
            "description":"The list of balances associated with the balance group.",
            "items":{
                "$ref":"#/components/schemas/Balances"
            }
        },
        "elem":{
            "type":"integer",
            "description":"The position of the entry in the array. For example, the first item in a list would have an <b>elem</b> value of <b>1</b>.",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    }
}

• Array of: object Balances
  The list of balances associated with the balance group.

{
    "type":"array",
    "description":"The list of balances associated with the balance group.",
    "items":{
        "$ref":"#/components/schemas/Balances"
    }
}

• Array of: object ServiceType

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

• creditFloor: number
  The credit floor associated with the balance.
• creditLimit: number
  The credit limit associated with the balance.
• creditThresholds: integer (int32)
  The credit thresholds associated with the balance.
• creditThresholdsFixed: string
  The value at which to send a notification, such as 30 US dollars or 30 minutes.
• currentBalance(required): number
  The current balance.
• dynamicCreditFloor: boolean
  Whether to use a dynamic credit floor (true) or not (false). The default is false.
• expiredBeforeUsing: number
  The number of days until the balance expires.
• formattedCreditThresholds: string
  The balance percentage usage at which to notify the customer.
• loanThresholds: integer (int32)
  The percent-based threshold for offering a loan. If the customer's balance falls below this percent, they are notified and offered a loan.
• loanThresholdsFixed: string
  The fixed amount threshold for offering a loan. If the customer's balance falls below this amount, they are notified and offered a loan.
• modifyLimit: boolean
  Whether a credit limit is being modified by the request (true) or not (false).
• outstandingAmount(required): number
  An amount that the customer still owes, for loans or when they exceed their credit limit.
• overrideCreditLimit: integer (int32)
  Whether to override the credit limit. Allowed Values: 0 (Enforce Credit Limit) or 1 (Override credit limit).
• resourceId: integer (int32)
  The resource ID associated with the balance.
• subBalances: array subBalances
• tempCreditLimit: array tempCreditLimit

{
    "required":[
        "currentBalance",
        "outstandingAmount"
    ],
    "type":"object",
    "properties":{
        "modifyLimit":{
            "type":"boolean",
            "description":"Whether a credit limit is being modified by the request (<b>true</b>) or not (<b>false</b>)."
        },
        "currentBalance":{
            "type":"number",
            "description":"The current balance."
        },
        "dynamicCreditFloor":{
            "type":"boolean",
            "description":"Whether to use a dynamic credit floor (<b>true</b>) or not (<b>false</b>). The default is <b>false</b>."
        },
        "creditFloor":{
            "type":"number",
            "description":"The credit floor associated with the balance."
        },
        "creditLimit":{
            "type":"number",
            "description":"The credit limit associated with the balance."
        },
        "overrideCreditLimit":{
            "type":"integer",
            "description":"Whether to override the credit limit. Allowed Values: <b>0</b> (Enforce Credit Limit) or <b>1</b> (Override credit limit).",
            "format":"int32"
        },
        "creditThresholds":{
            "type":"integer",
            "description":"The credit thresholds associated with the balance.",
            "format":"int32"
        },
        "formattedCreditThresholds":{
            "type":"string",
            "description":"The balance percentage usage at which to notify the customer."
        },
        "creditThresholdsFixed":{
            "type":"string",
            "description":"The value at which to send a notification, such as 30 US dollars or 30 minutes."
        },
        "expiredBeforeUsing":{
            "type":"number",
            "description":"The number of days until the balance expires."
        },
        "subBalances":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SubBalances"
            }
        },
        "outstandingAmount":{
            "type":"number",
            "description":"An amount that the customer still owes, for loans or when they exceed their credit limit."
        },
        "loanThresholds":{
            "type":"integer",
            "description":"The percent-based threshold for offering a loan. If the customer's balance falls below this percent, they are notified and offered a loan.",
            "format":"int32"
        },
        "loanThresholdsFixed":{
            "type":"string",
            "description":"The fixed amount threshold for offering a loan. If the customer's balance falls below this amount, they are notified and offered a loan."
        },
        "tempCreditLimit":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TempCreditLimit"
            }
        },
        "resourceId":{
            "type":"integer",
            "description":"The resource ID associated with the balance.",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"The list of balances associated with the balance group."
}

• Array of: object SubBalances

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

• Array of: object TempCreditLimit

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

• currentBalance: number
  The current amount of the sub-balance.
• elementId: integer (int32)
  The ID of the element.
• expiredBeforeUsing: number
  The number of days until the sub-balance expires.
• extension: object extension
  The extended attributes.
• originalBalance: number
  The original balance of the sub-balance.
• rolloverData: integer (int32)
  Indicates whether the leftover balance in this bucket will be rolled over, and if so, how.
• validFrom: string (date-time)
  The date and time the validity period starts.
• validTo: string (date-time)
  The date and time the validity period ends.

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "currentBalance":{
            "type":"number",
            "description":"The current amount of the sub-balance."
        },
        "originalBalance":{
            "type":"number",
            "description":"The original balance of the sub-balance."
        },
        "validFrom":{
            "type":"string",
            "description":"The date and time the validity period starts.",
            "format":"date-time"
        },
        "validTo":{
            "type":"string",
            "description":"The date and time the validity period ends.",
            "format":"date-time"
        },
        "rolloverData":{
            "type":"integer",
            "description":"Indicates whether the leftover balance in this bucket will be rolled over, and if so, how.",
            "format":"int32"
        },
        "expiredBeforeUsing":{
            "type":"number",
            "description":"The number of days until the sub-balance expires."
        },
        "elementId":{
            "type":"integer",
            "description":"The ID of the element.",
            "format":"int32"
        }
    }
}

• extension: object extension
  The extended attributes.
• limit: number
  The temporary credit limit amount.
• resourceId: integer (int32)
  The resource ID associated with the temporary credit limit.
• validFrom(required): string (date-time)
  The date and time temporary credit limit's validity starts.
• validFromOffset: integer (int32)
  The offset for the temporary credit limit's validity period start.
• validFromUnit: integer (int32)
  The unit for the temporary credit limit's validity period start.
• validTo(required): string (date-time)
  The date and time temporary credit limit's validity ends.
• validToOffset: integer (int32)
  The offset for the temporary credit limit's validity period end.
• validToUnit: integer (int32)
  The unit for the temporary credit limit's validity period end.

{
    "required":[
        "validFrom",
        "validTo"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "limit":{
            "type":"number",
            "description":"The temporary credit limit amount."
        },
        "resourceId":{
            "type":"integer",
            "description":"The resource ID associated with the temporary credit limit.",
            "format":"int32"
        },
        "validTo":{
            "type":"string",
            "description":"The date and time temporary credit limit's validity ends.",
            "format":"date-time"
        },
        "validFrom":{
            "type":"string",
            "description":"The date and time temporary credit limit's validity starts.",
            "format":"date-time"
        },
        "validToUnit":{
            "type":"integer",
            "description":"The unit for the temporary credit limit's validity period end.",
            "format":"int32"
        },
        "validToOffset":{
            "type":"integer",
            "description":"The offset for the temporary credit limit's validity period end.",
            "format":"int32"
        },
        "validFromUnit":{
            "type":"integer",
            "description":"The unit for the temporary credit limit's validity period start.",
            "format":"int32"
        },
        "validFromOffset":{
            "type":"integer",
            "description":"The offset for the temporary credit limit's validity period start.",
            "format":"int32"
        }
    }
}

• accountRef: object ResourceRef
• aliasList: array aliasList
  The list of aliases associated with the service.
• balanceGroupRef: object ResourceRef
• balGrpIndex: integer (int32)
  The balance group index.
• creationDate: string (date-time)
  The date and time the service type was created.
• effectiveDate: string (date-time)
• extension: object extension
  The extended attributes.
• id: object ResourceRef
• lastModified: string (date-time)
  The date and time the service was last modified.
• lastStatusChange: string (date-time)
  The date and time of the last status change.
• lastStatusComment: string
  The comment associated with the last status change.
• lifeCycleState: integer (int32)
  The current life cycle state.
• login(required): string
  The login associated with the service.
• name: string
  The name of the service.
• nameinfoObj: object ResourceRef
• password(required): string
  The password associated with the service.
• passwordExpiration: string (date-time)
  The date and time the password expires.
• passwordStatus: integer (int32)
  The current status of the password.
• pendingDeferredActionsCount: integer (int32)
  The number of deferred actions that are pending for the service.
• serviceAccessLevel: string
  The service access level.
• status: integer (int32)
  The status.
• statusFlags: integer (int32)
  The status flags.
• subscriptionServiceRef: object ResourceRef
• svcExpLastNotiOffset: string
  The notification offset.
• svcExpLastNotiT: string (date-time)
  The last notification time.

{
    "required":[
        "login",
        "password"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "pendingDeferredActionsCount":{
            "type":"integer",
            "description":"The number of deferred actions that are pending for the service.",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases associated with the service.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the service type was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastStatusComment":{
            "type":"string",
            "description":"The comment associated with the last status change."
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time of the last status change.",
            "format":"date-time"
        },
        "login":{
            "type":"string",
            "description":"The login associated with the service."
        },
        "lifeCycleState":{
            "type":"integer",
            "description":"The current life cycle state.",
            "format":"int32"
        },
        "lastModified":{
            "type":"string",
            "description":"The date and time the service was last modified.",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "password":{
            "type":"string",
            "description":"The password associated with the service."
        },
        "passwordExpiration":{
            "type":"string",
            "description":"The date and time the password expires.",
            "format":"date-time"
        },
        "passwordStatus":{
            "type":"integer",
            "description":"The current status of the password.",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The status.",
            "format":"int32"
        },
        "statusFlags":{
            "type":"integer",
            "description":"The status flags.",
            "format":"int32"
        },
        "subscriptionServiceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceAccessLevel":{
            "type":"string",
            "description":"The service access level."
        },
        "balGrpIndex":{
            "type":"integer",
            "description":"The balance group index.",
            "format":"int32"
        },
        "nameinfoObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "svcExpLastNotiOffset":{
            "type":"string",
            "description":"The notification offset."
        },
        "svcExpLastNotiT":{
            "type":"string",
            "description":"The last notification time.",
            "format":"date-time"
        }
    }
}

• Array of: object AliasList
  The list of aliases associated with the service.

{
    "type":"array",
    "description":"The list of aliases associated with the service.",
    "items":{
        "$ref":"#/components/schemas/AliasList"
    }
}

• elem: integer (int32)
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "elem":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"The list of aliases associated with the service."
}

• accountRef: object ResourceRef
• correctiveInvoiceType: integer (int32)
  The type of invoice to create, such as an invoice correction letter or a replacement invoice.
• details: object CreditCardTypeDetails
• extension: object extension
  The extended attributes.
• id: string
  The ID.
• name: string
  The payment instrument's name.
• paymentType: integer (int32)
  The payment type. Can be one of the following:

  • 10001:Invoice
  • 10003: Credit card
  • 10005: Direct debit
  • 10007: Subordinate

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The payment instrument's name."
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "correctiveInvoiceType":{
            "type":"integer",
            "description":"The type of invoice to create, such as an invoice correction letter or a replacement invoice.",
            "format":"int32"
        },
        "details":{
            "$ref":"#/components/schemas/CreditCardTypeDetails"
        }
    }
}

• accountRef: object ResourceRef
• correctiveInvoiceType: integer (int32)
  The type of invoice to create, such as an invoice correction letter or a replacement invoice.
• details: object DebitCardTypeDetails
• extension: object extension
  The extended attributes.
• id: string
  The ID.
• name: string
  The payment instrument's name.
• paymentType: integer (int32)
  The payment type. Can be one of the following:

  • 10001:Invoice
  • 10003: Credit card
  • 10005: Direct debit
  • 10007: Subordinate

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The payment instrument's name."
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "correctiveInvoiceType":{
            "type":"integer",
            "description":"The type of invoice to create, such as an invoice correction letter or a replacement invoice.",
            "format":"int32"
        },
        "details":{
            "$ref":"#/components/schemas/DebitCardTypeDetails"
        }
    }
}

• accountRef: object ResourceRef
• correctiveInvoiceType: integer (int32)
  The type of invoice to create, such as an invoice correction letter or a replacement invoice.
• details: object InvoiceTypeDetails
• extension: object extension
  The extended attributes.
• id: string
  The ID.
• name: string
  The payment instrument's name.
• paymentType: integer (int32)
  The payment type. Can be one of the following:

  • 10001:Invoice
  • 10003: Credit card
  • 10005: Direct debit
  • 10007: Subordinate

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The payment instrument's name."
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "correctiveInvoiceType":{
            "type":"integer",
            "description":"The type of invoice to create, such as an invoice correction letter or a replacement invoice.",
            "format":"int32"
        },
        "details":{
            "$ref":"#/components/schemas/InvoiceTypeDetails"
        }
    }
}

• accountRef: object ResourceRef
• correctiveInvoiceType: integer (int32)
  The type of invoice to create, such as an invoice correction letter or a replacement invoice.
• details: object SepaTypeDetails
• extension: object extension
  The extended attributes.
• id: string
  The ID.
• name: string
  The payment instrument's name.
• paymentType: integer (int32)
  The payment type. Can be one of the following:

  • 10001:Invoice
  • 10003: Credit card
  • 10005: Direct debit
  • 10007: Subordinate

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The payment instrument's name."
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "correctiveInvoiceType":{
            "type":"integer",
            "description":"The type of invoice to create, such as an invoice correction letter or a replacement invoice.",
            "format":"int32"
        },
        "details":{
            "$ref":"#/components/schemas/SepaTypeDetails"
        }
    }
}

• address: string
  The street address associated with the credit card.
• city: string
  The city associated with the credit card.
• country: string
  The country associated with the credit card.
• debitExp: string
  The credit card expiration in mmyy format.
• debitNumber: string
  The credit card number.
• name: string
  The name as it appears on the credit card.
• securityCode: string
  The credit card's 3-digit CVV2 or 4-digit CID.
• state: string
  The state associated with the credit card.
• zip: string
  The ZIP code associated with the credit card.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name as it appears on the credit card."
        },
        "address":{
            "type":"string",
            "description":"The street address associated with the credit card."
        },
        "city":{
            "type":"string",
            "description":"The city associated with the credit card."
        },
        "state":{
            "type":"string",
            "description":"The state associated with the credit card."
        },
        "zip":{
            "type":"string",
            "description":"The ZIP code associated with the credit card."
        },
        "country":{
            "type":"string",
            "description":"The country associated with the credit card."
        },
        "debitExp":{
            "type":"string",
            "description":"The credit card expiration in <i>mmyy</i> format."
        },
        "debitNumber":{
            "type":"string",
            "description":"The credit card number."
        },
        "securityCode":{
            "type":"string",
            "description":"The credit card's 3-digit CVV2 or 4-digit CID."
        }
    }
}

• accountType: integer
  The bank account type. Possible values are:

  • 1: Checking account
  • 2: Savings account
  • 3: Corporate account.
• address: string
  The street address associated with the bank account.
• bankNumber: string
  The RDFI or Bank ID used for routing transactions.
• cardActivationDate: string
  The date and time the card was activated.
• city: string
  The city associated with the bank account.
• country: string
  The country associated with the bank account.
• debitNumber: string
  The RDFI or Bank ID used for routing transactions.
• fiasId: string
  The FIAS ID.
• mandateReceivedDate: string
  The date and time the mandate was received.
• mandateStatus: integer
  The current mandate status.
• name: string
  The name as it appears on the bank account.
• state: string
  The state associated with the bank account.
• zip: string
  The ZIP code associated with the bank account.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name as it appears on the bank account."
        },
        "address":{
            "type":"string",
            "description":"The street address associated with the bank account."
        },
        "city":{
            "type":"string",
            "description":"The city associated with the bank account."
        },
        "state":{
            "type":"string",
            "description":"The state associated with the bank account."
        },
        "zip":{
            "type":"string",
            "description":"The ZIP code associated with the bank account."
        },
        "country":{
            "type":"string",
            "description":"The country associated with the bank account."
        },
        "bankNumber":{
            "type":"string",
            "description":"The RDFI or Bank ID used for routing transactions."
        },
        "debitNumber":{
            "type":"string",
            "description":"The RDFI or Bank ID used for routing transactions."
        },
        "accountType":{
            "type":"integer",
            "description":"The bank account type. Possible values are&colon; <ul><li><b>1</b>&colon; Checking account</li><li><b>2</b>&colon; Savings account</li><li><b>3</b>&colon; Corporate account.</li></ul>"
        },
        "mandateStatus":{
            "type":"integer",
            "description":"The current mandate status."
        },
        "cardActivationDate":{
            "type":"string",
            "description":"The date and time the card was activated."
        },
        "mandateReceivedDate":{
            "type":"string",
            "description":"The date and time the mandate was received."
        },
        "fiasId":{
            "type":"string",
            "description":"The FIAS ID."
        }
    }
}

• address: string
  The customer's street address.
• city: string
  The customer's city.
• country: string
  The customer's country.
• deliveryPrefer: string
  The customer's invoice delivery preference. Possible values are:

  • 0&colon Email
  • 1&colon Postal
  • 2&colon Fax
• elem: integer
  The position of the entry in the array. For example, the first item in a list would have an elem value of 1.
• emailAddr: string
  The customer's email address.
• invoiceID: string
  The invoice's ID.
• name: string
  The customer's name.
• state: string
  The customer's state.
• zip: string
  The customer's ZIP code.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The customer's name."
        },
        "invoiceID":{
            "type":"string",
            "description":"The invoice's ID."
        },
        "address":{
            "type":"string",
            "description":"The customer's street address."
        },
        "city":{
            "type":"string",
            "description":"The customer's city."
        },
        "state":{
            "type":"string",
            "description":"The customer's state."
        },
        "zip":{
            "type":"string",
            "description":"The customer's ZIP code."
        },
        "country":{
            "type":"string",
            "description":"The customer's country."
        },
        "deliveryPrefer":{
            "type":"string",
            "description":"The customer's invoice delivery preference. Possible values are&colon; <ul><li><b>0</b>&colon Email</li><li><b>1</b>&colon Postal</li><li><b>2</b>&colon Fax</li></ul>"
        },
        "emailAddr":{
            "type":"string",
            "description":"The customer's email address."
        },
        "elem":{
            "type":"integer",
            "description":"The position of the entry in the array. For example, the first item in a list would have an <b>elem</b> value of <b>1</b>."
        }
    }
}

• bankIdentifierCode: string
  The bank identifier code.
• creditorId: string
  The creditor's ID.
• creditorName: string
  The creditor's name.
• debtorInfo: object DebtorInfoDetails
• internationalBankAccountNumber: string
  The international bank account number.
• mandateAmended: integer
  The date and time the customer's SEPA mandate was last amended.
• mandateContractDescr: string
  The description of the customer's SEPA mandate contract.
• mandateContractId: string
  The ID of the customer's SEPA mandate contract.
• mandateEndDate: string
  The date and time the customer's SEPA mandate ends.
• mandateLastPostedDate: string
  The date and time the customer's SEPA mandate was last posted.
• mandateSignedDate: integer
  The position of the entry in the array. For example, the first item in a list would have an elem value of 1.
• mandateSignedPlace: string
  The date and time the customer's SEPA mandate contract was signed.
• mandateStatus: integer
  The status of the customer's SEPA mandate. Possible values are:

  • 0: Active
  • 1: Expired
  • 2: Canceled
• mandateType: integer
  The mandate type. Possible values are:

  • 0: One-off mandate
  • 1: Recurring mandate
• mandateUniqueReference: string
  The unique reference number for the mandate.

{
    "type":"object",
    "properties":{
        "bankIdentifierCode":{
            "type":"string",
            "description":"The bank identifier code."
        },
        "creditorId":{
            "type":"string",
            "description":"The creditor's ID."
        },
        "creditorName":{
            "type":"string",
            "description":"The creditor's name."
        },
        "debtorInfo":{
            "$ref":"#/components/schemas/DebtorInfoDetails"
        },
        "internationalBankAccountNumber":{
            "type":"string",
            "description":"The international bank account number."
        },
        "mandateLastPostedDate":{
            "type":"string",
            "description":"The date and time the customer's SEPA mandate was last posted."
        },
        "mandateAmended":{
            "type":"integer",
            "description":"The date and time the customer's SEPA mandate was last amended."
        },
        "mandateContractDescr":{
            "type":"string",
            "description":"The description of the customer's SEPA mandate contract."
        },
        "mandateContractId":{
            "type":"string",
            "description":"The ID of the customer's SEPA mandate contract."
        },
        "mandateEndDate":{
            "type":"string",
            "description":"The date and time the customer's SEPA mandate ends."
        },
        "mandateSignedDate":{
            "type":"integer",
            "description":"The position of the entry in the array. For example, the first item in a list would have an <b>elem</b> value of <b>1</b>."
        },
        "mandateSignedPlace":{
            "type":"string",
            "description":"The date and time the customer's SEPA mandate contract was signed."
        },
        "mandateStatus":{
            "type":"integer",
            "description":"The status of the customer's SEPA mandate. Possible values are&colon; <ul><li><b>0</b>&colon; Active</li><li><b>1</b>&colon; Expired</li><li><b>2</b>&colon; Canceled</li></ul>"
        },
        "mandateUniqueReference":{
            "type":"string",
            "description":"The unique reference number for the mandate."
        },
        "mandateType":{
            "type":"integer",
            "description":"The mandate type. Possible values are&colon; <ul><li><b>0</b>&colon; One-off mandate</li><li><b>1</b>&colon; Recurring mandate</li></ul>"
        }
    }
}

• address: string
  The debtor's address.
• city: string
  The debtor's city.
• country: string
  The debtor's country.
• identificationCode: string
  The debtor's bank identifier code.
• name: string
  The debtor's name.
• partyIdCode: string
  The debtor's party ID code.
• referencePartyName: string
  The debtor's party name.
• zip: string
  The debtor's ZIP code.

{
    "type":"object",
    "properties":{
        "address":{
            "type":"string",
            "description":"The debtor's address."
        },
        "city":{
            "type":"string",
            "description":"The debtor's city."
        },
        "country":{
            "type":"string",
            "description":"The debtor's country."
        },
        "name":{
            "type":"string",
            "description":"The debtor's name."
        },
        "zip":{
            "type":"string",
            "description":"The debtor's ZIP code."
        },
        "identificationCode":{
            "type":"string",
            "description":"The debtor's bank identifier code."
        },
        "referencePartyName":{
            "type":"string",
            "description":"The debtor's party name."
        },
        "partyIdCode":{
            "type":"string",
            "description":"The debtor's party ID code."
        }
    }
}

• address(required): string
  The customer's address.
• city(required): string
  The customer's city.
• company: string
  The company name.
• contactType: string
  The contact type.
• country(required): string
  The customer's country.
• deleted: boolean
  Default Value: false

  Whether to delete the contact (true) or not (false). This must be set to false if you adding a contact.
• elem: integer (int32)
  The position of the entry in the array. For example, the first item in a list would have an elem value of 1.
• emailAddress: string
  The customer's email address.
• firstName(required): string
  The customer's first name.
• lastName(required): string
  The customer's last name.
• middleName: string
  The customer's middle name.
• newlyCreated: boolean
  Default Value: false

  Whether the contact information was newly created (true) or not (false).
• phonenumbers: array phonenumbers
  The list of associated phone numbers.
• salutation: string
  The salutation to use use with the customer, such as Mr. or Miss.
• state: string
  The customer's state.
• title: string
  The customer's job title.
• zip: string
  The ZIP code.

{
    "required":[
        "address",
        "city",
        "country",
        "firstName",
        "lastName"
    ],
    "type":"object",
    "properties":{
        "address":{
            "type":"string",
            "description":"The customer's address."
        },
        "city":{
            "type":"string",
            "description":"The customer's city."
        },
        "company":{
            "type":"string",
            "description":"The company name."
        },
        "contactType":{
            "type":"string",
            "description":"The contact type."
        },
        "country":{
            "type":"string",
            "description":"The customer's country."
        },
        "emailAddress":{
            "type":"string",
            "description":"The customer's email address."
        },
        "firstName":{
            "type":"string",
            "description":"The customer's first name."
        },
        "lastName":{
            "type":"string",
            "description":"The customer's last name."
        },
        "middleName":{
            "type":"string",
            "description":"The customer's middle name."
        },
        "salutation":{
            "type":"string",
            "description":"The salutation to use use with the customer, such as Mr. or Miss."
        },
        "state":{
            "type":"string",
            "description":"The customer's state."
        },
        "title":{
            "type":"string",
            "description":"The customer's job title."
        },
        "zip":{
            "type":"string",
            "description":"The ZIP code."
        },
        "deleted":{
            "type":"boolean",
            "description":"Whether to delete the contact (<b>true</b>) or not (<b>false</b>). This must be set to <b>false</b> if you adding a contact.",
            "default":false
        },
        "newlyCreated":{
            "type":"boolean",
            "description":"Whether the contact information was newly created (<b>true</b>) or not (<b>false</b>).",
            "default":false
        },
        "phonenumbers":{
            "type":"array",
            "description":"The list of associated phone numbers.",
            "items":{
                "$ref":"#/components/schemas/Phonenumbers"
            }
        },
        "elem":{
            "type":"integer",
            "description":"The position of the entry in the array. For example, the first item in a list would have an <b>elem</b> value of <b>1</b>.",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"An account's contact information.",
    "xml":{
        "name":"contacts"
    }
}

• Array of: object Phonenumbers
  The list of the account's phone numbers.

{
    "type":"array",
    "description":"The list of associated phone numbers.",
    "items":{
        "$ref":"#/components/schemas/Phonenumbers"
    }
}

• number(required): string
  The phone number.
• phonetype: integer (int32)
  The phone number's type.

{
    "required":[
        "number"
    ],
    "type":"object",
    "properties":{
        "number":{
            "type":"string",
            "description":"The phone number."
        },
        "phonetype":{
            "type":"integer",
            "description":"The phone number's type.",
            "format":"int32"
        }
    },
    "description":"The list of the account's phone numbers."
}

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"object",
                "properties":{
                    "namespaceURI":{
                        "type":"string"
                    },
                    "localPart":{
                        "type":"string"
                    },
                    "prefix":{
                        "type":"string"
                    }
                }
            },
            "value":{
                "$ref":"#/components/schemas/PaymentInstrumentType"
            },
            "nil":{
                "type":"boolean"
            },
            "globalScope":{
                "type":"boolean"
            },
            "typeSubstituted":{
                "type":"boolean"
            }
        }
    }
}

• globalScope: boolean
• name: object name
• nil: boolean
• typeSubstituted: boolean
• value: object PaymentInstrumentType

{
    "type":"object",
    "properties":{
        "name":{
            "type":"object",
            "properties":{
                "namespaceURI":{
                    "type":"string"
                },
                "localPart":{
                    "type":"string"
                },
                "prefix":{
                    "type":"string"
                }
            }
        },
        "value":{
            "$ref":"#/components/schemas/PaymentInstrumentType"
        },
        "nil":{
            "type":"boolean"
        },
        "globalScope":{
            "type":"boolean"
        },
        "typeSubstituted":{
            "type":"boolean"
        }
    }
}

• localPart: string
• namespaceURI: string
• prefix: string

{
    "type":"object",
    "properties":{
        "namespaceURI":{
            "type":"string"
        },
        "localPart":{
            "type":"string"
        },
        "prefix":{
            "type":"string"
        }
    }
}

• accountRef: object ResourceRef
• correctiveInvoiceType: integer (int32)
  The type of invoice to create, such as an invoice correction letter or a replacement invoice.
• extension: object extension
  The extended attributes.
• id: string
  The ID.
• name: string
  The payment instrument's name.
• paymentType: integer (int32)
  The payment type. Can be one of the following:

  • 10001:Invoice
  • 10003: Credit card
  • 10005: Direct debit
  • 10007: Subordinate

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The payment instrument's name."
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "correctiveInvoiceType":{
            "type":"integer",
            "description":"The type of invoice to create, such as an invoice correction letter or a replacement invoice.",
            "format":"int32"
        }
    }
}