Sales Deed API (1.0)
Download OpenAPI specification:
If you have any questions, comments or feedback regarding our APIs, please contact developer@ovipro.fi.
Create Sales Deed
Creates a new sales deed. A new sales deed can be created only
for a trade settlement that has no sales deeds in DRAFT status.
Authorizations:
path Parameters
| tradeSettlementId required | string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: 6d9d4946-d170-4730-b818-37901edb961b Unique trade settlement identifier in UUID format. |
header Parameters
| Request-ID required | string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
Request Body schema: application/jsonrequired
| salesDeedContent required | string (SalesDeedContent) <= 100000 characters JSON escaped markdown content for sales deed. |
Responses
Request samples
- Payload
{- "salesDeedContent": "# Sales Deed\\n\\nThis is the sales deed content in markdown.\n"
}Response samples
- 201
- 400
- 401
- 403
- 409
- 429
- 500
{- "salesDeedId": "c6d2288d-2ecb-448a-aef3-fd5144920e0b"
}List Sales Deeds
Retrieves a list of all sales deeds for a specific trade settlement. Sales deeds are returned in ascending order by their version number.
Authorizations:
path Parameters
| tradeSettlementId required | string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: 6d9d4946-d170-4730-b818-37901edb961b Unique trade settlement identifier in UUID format. |
header Parameters
| Request-ID required | string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 429
- 500
{- "salesDeeds": [
- {
- "salesDeedId": "f1b3a3b0-1f2e-4d5b-9c6a-7e8f9a0b1c2d",
- "version": 1,
- "status": "INSPECTED",
- "documentId": "d9b1f8c2-3e4f-4a5b-8c6d-7e8f9a0b1c2d",
- "creationTime": "2024-01-15T10:30:00Z",
- "modificationTime": "2024-01-16T09:10:00Z",
- "inspectionTime": "2024-01-16T09:15:00Z"
}, - {
- "salesDeedId": "c6d2288d-2ecb-448a-aef3-fd5144920e0b",
- "version": 2,
- "status": "DRAFT",
- "creationTime": "2024-01-16T10:30:00Z",
- "modificationTime": "2024-01-16T12:00:00Z"
}
]
}Get Sales Deed
Retrieves a specific sales deed by its identifier.
Authorizations:
path Parameters
| tradeSettlementId required | string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: 6d9d4946-d170-4730-b818-37901edb961b Unique trade settlement identifier in UUID format. |
| salesDeedId required | string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: c6d2288d-2ecb-448a-aef3-fd5144920e0b Unique sales deed identifier in UUID format. |
header Parameters
| Request-ID required | string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 429
- 500
{- "salesDeedId": "f1b3a3b0-1f2e-4d5b-9c6a-7e8f9a0b1c2d",
- "version": 1,
- "salesDeedContent": "# Sales Deed\n\nThis is the inspected sales deed content in markdown.",
- "status": "INSPECTED",
- "documentId": "d9b1f8c2-3e4f-4a5b-8c6d-7e8f9a0b1c2d",
- "creationTime": "2024-01-15T10:30:00Z",
- "modificationTime": "2024-01-16T09:10:00Z",
- "inspectionTime": "2024-01-16T09:15:00Z"
}Update Sales Deed
Updates an existing sales deed with given content.
Sales deed must be in DRAFT status to be updated.
Authorizations:
path Parameters
| tradeSettlementId required | string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: 6d9d4946-d170-4730-b818-37901edb961b Unique trade settlement identifier in UUID format. |
| salesDeedId required | string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: c6d2288d-2ecb-448a-aef3-fd5144920e0b Unique sales deed identifier in UUID format. |
header Parameters
| Request-ID required | string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
Request Body schema: application/jsonrequired
| salesDeedContent required | string (SalesDeedContent) <= 100000 characters JSON escaped markdown content for sales deed. |
Responses
Request samples
- Payload
{- "salesDeedContent": "# Sales Deed\\n\\nThis is the sales deed content in markdown.\n"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 429
- 500
{ }Delete Sales Deed
Deletes a specific sales deed by its identifier.
Sales deed must be in DRAFT status to be deleted.
Authorizations:
path Parameters
| tradeSettlementId required | string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: 6d9d4946-d170-4730-b818-37901edb961b Unique trade settlement identifier in UUID format. |
| salesDeedId required | string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: c6d2288d-2ecb-448a-aef3-fd5144920e0b Unique sales deed identifier in UUID format. |
header Parameters
| Request-ID required | string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 429
- 500
{ }Inspect Sales Deed
Inspects a specific sales deed, transitioning it from DRAFT to INSPECTED status. This operation can only be performed on sales deeds with DRAFT status. As a side effect, a PDF document of the sales deed is generated.
Authorizations:
path Parameters
| tradeSettlementId required | string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: 6d9d4946-d170-4730-b818-37901edb961b Unique trade settlement identifier in UUID format. |
| salesDeedId required | string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: c6d2288d-2ecb-448a-aef3-fd5144920e0b Unique sales deed identifier in UUID format. |
header Parameters
| Request-ID required | string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
Request Body schema: application/jsonrequired
Responses
Request samples
- Payload
{ }Response samples
- 200
- 400
- 401
- 403
- 404
- 409
- 429
- 500
{ }Preview Sales Deed
Generates a temporary PDF preview of a sales deed without persisting it. The sales deed content is provided directly in the request body. Returns a temporary download URL for viewing the preview.
Authorizations:
path Parameters
| tradeSettlementId required | string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: 6d9d4946-d170-4730-b818-37901edb961b Unique trade settlement identifier in UUID format. |
header Parameters
| Request-ID required | string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
Request Body schema: application/jsonrequired
| salesDeedContent required | string (SalesDeedContent) <= 100000 characters JSON escaped markdown content for sales deed. |
Responses
Request samples
- Payload
{- "salesDeedContent": "# Sales Deed\\n\\nThis is the sales deed content in markdown.\n"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 429
- 500
{
}