Property | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
bodyContainsMagicBlank read-only |
Indicates if the HTML body of the contract contains one or more magic blank placeholder strings. |
||||||||||||||
contacts read-only |
A collection of contacts associated with this contract |
||||||||||||||
contractStatus |
The current status of the contract.
|
||||||||||||||
created |
The creation date of this contract. |
||||||||||||||
expirationDate |
The date on which this contract expires. |
||||||||||||||
id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
invoices |
An array of linked invoices. |
||||||||||||||
isEditable |
Whether the contract is able to be edited. |
||||||||||||||
links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||||||||||||
name |
The name for this contract. |
||||||||||||||
publicId |
The public identifier for this contract (may be used in the portal website). |
||||||||||||||
type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"properties": {
"bodyContainsMagicBlank": {
"description": "Indicates if the HTML body of the contract contains one or more\n*magic blank* placeholder strings.",
"readOnly": true,
"type": "boolean"
},
"contacts": {
"description": "A collection of contacts associated with this contract",
"items": {
"$ref": "#/components/schemas/ContactCollectionMinimal"
},
"readOnly": true
},
"contractStatus": {
"$ref": "#/components/schemas/Contract/properties/contractStatus"
},
"created": {
"description": "The creation date of this contract.",
"format": "date-time",
"type": "string"
},
"expirationDate": {
"description": "The date on which this contract expires.",
"format": "date-time",
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"invoices": {
"description": "An array of linked invoices.",
"items": {
"$ref": "#/components/schemas/InvoiceMinimal"
},
"title": "Invoice",
"type": "array"
},
"isEditable": {
"description": "Whether the contract is able to be edited.",
"type": "boolean"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"name": {
"description": "The name for this contract.",
"type": "string"
},
"publicId": {
"description": "The public identifier for this contract (may be used in the portal\nwebsite).",
"pattern": "^[a-fA-F0-9]{32}$",
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/Type"
},
{
"enum": [
"contract"
]
}
]
}
},
"title": "Contract",
"type": "object"
}