Properties
| Name | Type | Description |
|---|---|---|
| type | string | The type of definition. |
| counterparty_alias | object | The alias of the party we are allocating the money to. |
| description | string | The description for the payment. |
| amount | object | The amount to allocate. |
| fraction | integer | The percentage of the triggering payment's amount to allocate. |
| id | integer | The id of the PaymentAutoAllocateDefinition. |
| created | string | The timestamp when the PaymentAutoAllocateDefinition was created. |
| updated | string | The timestamp when the PaymentAutoAllocateDefinition was last updated. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/PaymentAutoAllocateDefinition",
"title": "PaymentAutoAllocateDefinition",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of definition.",
"readOnly": false,
"writeOnly": true
},
"counterparty_alias": {
"type": "object",
"description": "The alias of the party we are allocating the money to.",
"readOnly": false,
"writeOnly": false,
"$ref": "#/components/schemas/Pointer"
},
"description": {
"type": "string",
"description": "The description for the payment.",
"readOnly": false,
"writeOnly": false
},
"amount": {
"type": "object",
"description": "The amount to allocate.",
"readOnly": false,
"writeOnly": false,
"$ref": "#/components/schemas/Amount"
},
"fraction": {
"type": "integer",
"description": "The percentage of the triggering payment's amount to allocate.",
"readOnly": false,
"writeOnly": false
},
"id": {
"type": "integer",
"description": "The id of the PaymentAutoAllocateDefinition.",
"readOnly": true,
"writeOnly": false
},
"created": {
"type": "string",
"description": "The timestamp when the PaymentAutoAllocateDefinition was created.",
"readOnly": true,
"writeOnly": false
},
"updated": {
"type": "string",
"description": "The timestamp when the PaymentAutoAllocateDefinition was last updated.",
"readOnly": true,
"writeOnly": false
}
},
"required": [
"type"
]
}