• _client_driven_action(optional): boolean
• documents(optional): object documents

{
    "title":"Synchronize Request",
    "type":"object",
    "properties":{
        "_client_driven_action":{
            "type":"boolean"
        },
        "documents":{
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/Assets"
                            },
                            {
                                "properties":{
                                    "_sync_action":{
                                        "type":"string"
                                    }
                                }
                            }
                        ]
                    }
                }
            }
        }
    }
}

• items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Assets"
                    },
                    {
                        "properties":{
                            "_sync_action":{
                                "type":"string"
                            }
                        }
                    }
                ]
            }
        }
    }
}

• Array of: items

{
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Assets"
            },
            {
                "properties":{
                    "_sync_action":{
                        "type":"string"
                    }
                }
            }
        ]
    }
}

• object Assets
  Title: Assets
• object items-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/Assets"
        },
        {
            "properties":{
                "_sync_action":{
                    "type":"string"
                }
            }
        }
    ]
}

• _proxy_id(optional): string
  Title: _proxy_id

  temporary record identifier; optional field applicable only in the context of synchronize action
• _sync_action(optional): string
  Title: _sync_action

  record level operation; optional field applicable only in the context of synchronize action
• assetDescription(optional): string
  Title: Asset Description

  Description of the asset.
• assetKey(optional): string
  Title: Asset Key

  An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.
• attributes(optional): string
  Title: Attributes

  A collection (JSON) of key/value pair attributes that define the configuration of this asset/component.
• billingAccount(optional): string
  Title: Billing Account

  The billing account associated with this asset.
• billingProfile(optional): string
  Title: Billing Profile

  The billing profile associated with this asset.
• contractReference(optional): string
  Title: Contract

  Contract associated with this asset.
• currency(optional): object Currency
  Title: Currency

  Currency Code for the asset
• customer(optional): string
  Title: Customer

  The customer that owns the product. This is the value stored in main doc XML attribute _customer_id.
• dateAdded(optional): string
  Title: Date Added

  System field indicating the date on which the Resource was created.
• dateModified(optional): string
  Title: Date Modified

  System field indicating the date on which the Resource was last modified.
• discountAmount(optional): object DiscountAmount
  Title: DiscountAmount

  The amount of discount received
• discountPercent(optional): number
  Title: DiscountPercent

  The percent of discount received.
• displayKey(optional): string
  Title: Display

  The public, non-unique key for the product instance. For example, phone number or serial number.
• endDate(optional): string
  Title: Ends On

  Date on which the service contract ends
• fixedRecurringAmount(optional): object Fixed Recurring Amount
  Title: Fixed Recurring Amount

  The recurring charge for the product. For example, $10 per month.
• fixedRecurringPeriod(optional): string
  Title: Fixed Recurring Period

  The period for the fixed recurring charge. For example, Per Month.
• id(optional): integer
  Title: Id

  Primary Key of Asset Resource.
• installDate(optional): string
  Title: Installed On

  Date on which asset was installed.
• oneTimeNetAmount(optional): object One Time Net Amount
  Title: One Time Net Amount

  The price paid to purchase the product
• parentAsset(optional): object Parent Asset Id
  Title: Parent Asset Id

  The parent component of the asset bill of materials tree
• parentDisplay(optional): string
  Title: Parent Display

  The display key of the parent asset.
• parentPartNumber(optional): string
  Title: Parent Part Number

  The part number of the parent asset.
• partDescription(optional): string
  Title: Part Description

  The description of the part.
• partNumber(optional): string
  Title: Part Number

  Part Number of the referenced product instance.
• paymentTerm(optional): string
  Title: Payment Term

  The payment terms. For example, Net 30.
• purchaseDate(optional): string
  Title: Purchased On

  Date on which the product/service was purchased.
• quantity(optional): number
  Title: Quantity

  The quantity of the asset.
• registeredDate(optional): string
  Title: Registered On

  Date on which product was registered.
• resumeDate(optional): string
  Title: Resumed On

  Date on which the service contract was resumed
• rootAsset(optional): object Root Asset Id
  Title: Root Asset Id

  The root component in the asset bill of materials tree.
• rootDisplay(optional): string
  Title: Root Display

  The display key of the root asset.
• rootPartNumber(optional): string
  Title: Root Part Number

  The part number of the root asset.
• serialNumber(optional): string
  Title: Serial Number

  Serial Number of the asset.
• serviceAccount(optional): string
  Title: Service Account

  The service account associated with this asset.
• serviceAddress(optional): string
  Title: Service Address

  The service address associated with this asset.
• startDate(optional): string
  Title: Starts On

  Date on which the service contract starts
• status(optional): object Status
  Title: Status

  The status of the asset
• suspendDate(optional): string
  Title: Suspended On

  Date on which the service contract was suspended
• usageNetAmount(optional): object Usage Net Amount
  Title: Usage Net Amount

  The variable, usage price for the product. For example, $0.10 per Copy.
• usageUnitOfMeasure(optional): string
  Title: Usage Unit of Measure

  The unit of measure for the usage charges. For example, Per Copy or Per Minute.
• warrantyEndDate(optional): string
  Title: Warranty Ends On

  Date on which warranty ends.
• warrantyStartDate(optional): string
  Title: Warranty Starts On

  Date on which warranty starts.

{
    "type":"object",
    "properties":{
        "assetDescription":{
            "title":"Asset Description",
            "description":"Description of the asset.",
            "type":"string"
        },
        "assetKey":{
            "type":"string",
            "description":"An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.",
            "title":"Asset Key"
        },
        "attributes":{
            "type":"string",
            "description":"A collection (JSON) of key/value pair attributes that define the configuration of this asset/component.",
            "title":"Attributes"
        },
        "billingAccount":{
            "title":"Billing Account",
            "description":"The billing account associated with this asset.",
            "type":"string"
        },
        "billingProfile":{
            "title":"Billing Profile",
            "description":"The billing profile associated with this asset.",
            "type":"string"
        },
        "contractReference":{
            "title":"Contract",
            "description":"Contract associated with this asset.",
            "type":"string"
        },
        "currency":{
            "type":"object",
            "description":"Currency Code for the asset",
            "title":"Currency",
            "properties":{
                "currencyCode":{
                    "type":"string",
                    "description":"Unique currency code for the currency.",
                    "title":"Currency Code"
                }
            }
        },
        "customer":{
            "type":"string",
            "description":"The customer that owns the product. This is the value stored in main doc XML attribute _customer_id.",
            "title":"Customer"
        },
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "discountAmount":{
            "type":"object",
            "description":"The amount of discount received",
            "title":"DiscountAmount",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "discountPercent":{
            "type":"number",
            "description":"The percent of discount received.",
            "title":"DiscountPercent"
        },
        "displayKey":{
            "type":"string",
            "description":"The public, non-unique key for the product instance. For example, phone number or serial number. ",
            "title":"Display"
        },
        "endDate":{
            "type":"string",
            "description":"Date on which the service contract ends",
            "title":"Ends On"
        },
        "fixedRecurringAmount":{
            "type":"object",
            "description":"The recurring charge for the product. For example, $10 per month. ",
            "title":"Fixed Recurring Amount",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "fixedRecurringPeriod":{
            "type":"string",
            "description":"The period for the fixed recurring charge. For example, Per Month.",
            "title":"Fixed Recurring Period"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of Asset Resource.",
            "title":"Id"
        },
        "installDate":{
            "title":"Installed On",
            "description":"Date on which asset was installed.",
            "type":"string"
        },
        "oneTimeNetAmount":{
            "type":"object",
            "description":"The price paid to purchase the product",
            "title":"One Time Net Amount",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "parentAsset":{
            "type":"object",
            "description":"The parent component of the asset bill of materials tree",
            "title":"Parent Asset Id",
            "properties":{
                "id":{
                    "type":"integer",
                    "description":"Primary Key of Asset Resource.",
                    "title":"Id"
                },
                "assetKey":{
                    "type":"string",
                    "description":"An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.",
                    "title":"Asset Key"
                }
            }
        },
        "parentDisplay":{
            "type":"string",
            "description":"The display key of the parent asset.",
            "title":"Parent Display"
        },
        "parentPartNumber":{
            "type":"string",
            "description":"The part number of the parent asset.",
            "title":"Parent Part Number"
        },
        "partDescription":{
            "title":"Part Description",
            "description":"The description of the part.",
            "type":"string"
        },
        "partNumber":{
            "type":"string",
            "description":"Part Number of the referenced product instance.",
            "title":"Part Number"
        },
        "paymentTerm":{
            "type":"string",
            "description":"The payment terms. For example, Net 30.",
            "title":"Payment Term"
        },
        "purchaseDate":{
            "title":"Purchased On",
            "description":"Date on which the product/service was purchased.",
            "type":"string"
        },
        "quantity":{
            "type":"number",
            "description":"The quantity of the asset.",
            "title":"Quantity"
        },
        "registeredDate":{
            "title":"Registered On",
            "description":"Date on which product was registered.",
            "type":"string"
        },
        "resumeDate":{
            "type":"string",
            "description":"Date on which the service contract was resumed",
            "title":"Resumed On"
        },
        "rootAsset":{
            "type":"object",
            "description":"The root component in the asset bill of materials tree.",
            "title":"Root Asset Id",
            "properties":{
                "id":{
                    "type":"integer",
                    "description":"Primary Key of Asset Resource.",
                    "title":"Id"
                },
                "assetKey":{
                    "type":"string",
                    "description":"An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.",
                    "title":"Asset Key"
                }
            }
        },
        "rootDisplay":{
            "type":"string",
            "description":"The display key of the root asset.",
            "title":"Root Display"
        },
        "rootPartNumber":{
            "type":"string",
            "description":"The part number of the root asset.",
            "title":"Root Part Number"
        },
        "serialNumber":{
            "title":"Serial Number",
            "description":"Serial Number of the asset.",
            "type":"string"
        },
        "serviceAccount":{
            "title":"Service Account",
            "description":"The service account associated with this asset.",
            "type":"string"
        },
        "serviceAddress":{
            "title":"Service Address",
            "description":"The service address associated with this asset.",
            "type":"string"
        },
        "startDate":{
            "type":"string",
            "description":"Date on which the service contract starts",
            "title":"Starts On"
        },
        "status":{
            "type":"object",
            "description":"The status of the asset",
            "title":"Status",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "suspendDate":{
            "type":"string",
            "description":"Date on which the service contract was suspended",
            "title":"Suspended On"
        },
        "usageNetAmount":{
            "type":"object",
            "description":"The variable, usage price for the product. For example, $0.10 per Copy.",
            "title":"Usage Net Amount",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "usageUnitOfMeasure":{
            "type":"string",
            "description":"The unit of measure for the usage charges. For example, Per Copy or Per Minute. ",
            "title":"Usage Unit of Measure"
        },
        "warrantyEndDate":{
            "title":"Warranty Ends On",
            "description":"Date on which warranty ends.",
            "type":"string"
        },
        "warrantyStartDate":{
            "title":"Warranty Starts On",
            "description":"Date on which warranty starts.",
            "type":"string"
        },
        "_proxy_id":{
            "title":"_proxy_id",
            "description":"temporary record identifier; optional field applicable only in the context of synchronize action",
            "type":"string"
        },
        "_sync_action":{
            "title":"_sync_action",
            "description":"record level operation; optional field applicable only in the context of synchronize action",
            "type":"string"
        }
    },
    "title":"Assets"
}

• _sync_action(optional): string

{
    "properties":{
        "_sync_action":{
            "type":"string"
        }
    }
}

• currencyCode(optional): string
  Title: Currency Code

  Unique currency code for the currency.

{
    "type":"object",
    "description":"Currency Code for the asset",
    "title":"Currency",
    "properties":{
        "currencyCode":{
            "type":"string",
            "description":"Unique currency code for the currency.",
            "title":"Currency Code"
        }
    }
}

• currency(optional): string
  Title: currency
• value(optional): number
  Title: value

{
    "type":"object",
    "description":"The amount of discount received",
    "title":"DiscountAmount",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

• currency(optional): string
  Title: currency
• value(optional): number
  Title: value

{
    "type":"object",
    "description":"The recurring charge for the product. For example, $10 per month. ",
    "title":"Fixed Recurring Amount",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

• currency(optional): string
  Title: currency
• value(optional): number
  Title: value

{
    "type":"object",
    "description":"The price paid to purchase the product",
    "title":"One Time Net Amount",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

• assetKey(optional): string
  Title: Asset Key

  An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.
• id(optional): integer
  Title: Id

  Primary Key of Asset Resource.

{
    "type":"object",
    "description":"The parent component of the asset bill of materials tree",
    "title":"Parent Asset Id",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Primary Key of Asset Resource.",
            "title":"Id"
        },
        "assetKey":{
            "type":"string",
            "description":"An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.",
            "title":"Asset Key"
        }
    }
}

• assetKey(optional): string
  Title: Asset Key

  An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.
• id(optional): integer
  Title: Id

  Primary Key of Asset Resource.

{
    "type":"object",
    "description":"The root component in the asset bill of materials tree.",
    "title":"Root Asset Id",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Primary Key of Asset Resource.",
            "title":"Id"
        },
        "assetKey":{
            "type":"string",
            "description":"An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.",
            "title":"Asset Key"
        }
    }
}

• displayValue(optional): string
  Title: Display Value

  Translated display name of the type for which fixed list of values can be defined.
• id(optional): integer
  Title: Id

  Primary Key of the fixed list of value resource.
• lookupCode(optional): string
  Title: Lookup Code

  Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"The status of the asset",
    "title":"Status",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

• currency(optional): string
  Title: currency
• value(optional): number
  Title: value

{
    "type":"object",
    "description":"The variable, usage price for the product. For example, $0.10 per Copy.",
    "title":"Usage Net Amount",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}