• Array of: object CustomerDeposit

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

• balanceAmount: object Money
• billProfileRef(required): string
  The bill profile reference.
• code(required): string
  The external identifier.
• createdAt(required): string
  The date when the customer deposit is created.
• customerRef(required): string
  The customer reference.
• depositSpecName(required): string
  The deposit specoification name.
• depositSpecRef(required): string
  The deposit specification reference.
• discountAmount: object Money
• effectiveDate(required): string
  The date from which the customer deposit is effective.
• href(required): string
  The unique resource URL, used to get the object.
• id(required): string
  The customer deposit ID.
• interestAmount: object Money
• modifiedAt(required): string
  The date when the customer deposit is modified.
• notes: string
  The notes for the customer deposit.
• receivedAmount: object Money
• releasedAmount: object Money
• releaseType: integer (int32)
  The release type. Allowed Values: 1 (Prepayment), 2 (Refund), 3 (Zeroise).
• serviceRef(required): string
  The service reference.
• status(required): string
  The deposit status. Allowed Values: WAITING, ACTIVE, EXPIRED, TRANSFERRED, RELEASED, REFUNDED, CANCELLED
• totalAmount: object Money
• transactions(required): array transactions
• validFor: object TimePeriod
• validityRule: object DepositValidityRule

{
    "required":[
        "billProfileRef",
        "code",
        "createdAt",
        "customerRef",
        "depositSpecName",
        "depositSpecRef",
        "effectiveDate",
        "href",
        "id",
        "modifiedAt",
        "serviceRef",
        "status",
        "transactions"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The customer deposit ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the customer deposit is created."
        },
        "modifiedAt":{
            "type":"string",
            "description":"The date when the customer deposit is modified."
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date from which the customer deposit is effective."
        },
        "status":{
            "type":"string",
            "description":"The deposit status. Allowed Values: WAITING, ACTIVE, EXPIRED, TRANSFERRED, RELEASED, REFUNDED, CANCELLED"
        },
        "totalAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "notes":{
            "type":"string",
            "description":"The notes for the customer deposit."
        },
        "receivedAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "releasedAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "interestAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "balanceAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "discountAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "depositSpecRef":{
            "type":"string",
            "description":"The deposit specification reference."
        },
        "depositSpecName":{
            "type":"string",
            "description":"The deposit specoification name."
        },
        "serviceRef":{
            "type":"string",
            "description":"The service reference."
        },
        "billProfileRef":{
            "type":"string",
            "description":"The bill profile reference."
        },
        "releaseType":{
            "type":"integer",
            "description":"The release type. Allowed Values: <b>1</b> (Prepayment), <b>2</b> (Refund), <b>3</b> (Zeroise).",
            "format":"int32"
        },
        "code":{
            "type":"string",
            "description":"The external identifier."
        },
        "transactions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomerDepositTransactions"
            }
        },
        "validityRule":{
            "$ref":"#/components/schemas/DepositValidityRule"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        }
    }
}

• amount(required): number
  The amount of money.
• currency: integer (int32)
  The currency for the money.

{
    "required":[
        "amount"
    ],
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"The amount of money."
        },
        "currency":{
            "type":"integer",
            "description":"The currency for the money.",
            "format":"int32"
        }
    }
}

• Array of: object CustomerDepositTransactions

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

• endDateTime(required): string
• startDateTime(required): string

{
    "required":[
        "endDateTime",
        "startDateTime"
    ],
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string"
        },
        "endDateTime":{
            "type":"string"
        }
    }
}

• endOffsetPeriodUnit: integer (int32)
  The unit of measure for the end offset.
  Allowed Values:

  • 0 (Month)
  • 1 (Day)
  • 2 (Week)
  • 3 (Year)
• endOffsetPeriodValue: integer (int32)
  The value for the end offset.

{
    "type":"object",
    "properties":{
        "endOffsetPeriodUnit":{
            "type":"integer",
            "description":"The unit of measure for the end offset.<br/>Allowed Values: <ul><li><b>0</b> (Month)</li><li><b>1</b> (Day)</li><li><b>2</b> (Week)</li><li><b>3</b> (Year)</li></ul>",
            "format":"int32"
        },
        "endOffsetPeriodValue":{
            "type":"integer",
            "description":"The value for the end offset.",
            "format":"int32"
        }
    }
}

• transactionRef(required): string
  Reference to the transaction record.
• transactions(required): string
  The transactions.

{
    "required":[
        "transactionRef",
        "transactions"
    ],
    "type":"object",
    "properties":{
        "transactions":{
            "type":"string",
            "description":"The transactions."
        },
        "transactionRef":{
            "type":"string",
            "description":"Reference to the transaction record."
        }
    }
}