v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Return

View return document

Returns details of a single return document

get/api/v1/returns/{id}/documents/{documentId}

Path parameters

documentIdstring required

Resource identifier.

Example:17

ID of document

idstring required

Resource identifier.

Example:17

The resource's identifier.

Query parameters

numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

Response

Operation completed successfully.

Example response

{
  "data": {
    "id": "17",
    "entity": "Return entity",
    "entityId": 12,
    "title": "Return title",
    "description": "List of return document",
    "keyword": "attachment",
    "sort": 1,
    "versions": [
      {
        "id": "abc123",
        "version": 1,
        "remark": "Initial version of the document.",
        "filename": "document_v1.pdf",
        "size": {
          "value": 210,
          "unit": "byte"
        },
        "updatedAt": "2024-09-18T14:30:00Z"
      }
    ],
    "currentVersion": {
      "id": "abc123",
      "version": 1,
      "remark": "Initial version of the document.",
      "filename": "document_v1.pdf",
      "size": {
        "value": 210,
        "unit": "byte"
      },
      "updatedAt": "2024-09-18T14:30:00Z"
    },
    "updatedAt": "2024-09-18T14:30:00Z"
  }
}