Skip to main content

API Change Log - Finance

🧩 Service: Finance​

🔧 Operation: generateReport​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.generateReport.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.start_date.format
  • New Schema:
"date-time"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.generateReport.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.end_date.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportPlatform --> GenerateReportPlatform/properties --> GenerateReportPlatform/properties/meta --> GenerateReportMeta --> GenerateReportPlatform/properties/meta/properties --> GenerateReportPlatform/properties/meta/properties/brand
  • Schema Action: NULLABLE_ADDED
  • Path: paths.generateReport.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.meta.properties.brand.nullable
  • New Schema:
true

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportPlatform --> GenerateReportPlatform/properties --> GenerateReportPlatform/properties/meta --> GenerateReportMeta --> GenerateReportPlatform/properties/meta/properties --> GenerateReportPlatform/properties/meta/properties/company
  • Schema Action: NULLABLE_ADDED
  • Path: paths.generateReport.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.meta.properties.company.nullable
  • New Schema:
true

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportPlatform --> GenerateReportPlatform/properties --> GenerateReportPlatform/properties/meta --> GenerateReportMeta --> GenerateReportPlatform/properties/meta/properties --> GenerateReportPlatform/properties/meta/properties/channel
  • Schema Action: NULLABLE_ADDED
  • Path: paths.generateReport.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.meta.properties.channel.nullable
  • New Schema:
true

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportPlatform --> GenerateReportPlatform/properties --> GenerateReportPlatform/properties/filters --> GenerateReportFilters --> GenerateReportPlatform/properties/filters/properties --> GenerateReportPlatform/properties/filters/properties/brand
  • Schema Action: NULLABLE_ADDED
  • Path: paths.generateReport.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.filters.properties.brand.nullable
  • New Schema:
true

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportPlatform --> GenerateReportPlatform/properties --> GenerateReportPlatform/properties/filters --> GenerateReportFilters --> GenerateReportPlatform/properties/filters/properties --> GenerateReportPlatform/properties/filters/properties/company
  • Schema Action: NULLABLE_ADDED
  • Path: paths.generateReport.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.filters.properties.company.nullable
  • New Schema:
true

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportPlatform --> GenerateReportPlatform/properties --> GenerateReportPlatform/properties/filters --> GenerateReportFilters --> GenerateReportPlatform/properties/filters/properties --> GenerateReportPlatform/properties/filters/properties/channel
  • Schema Action: NULLABLE_ADDED
  • Path: paths.generateReport.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.filters.properties.channel.nullable
  • New Schema:
true

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.generateReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties
  • New Schema:
{
"data": {
"type": "object",
"additionalProperties": true
},
"item_count": {
"type": "integer",
"description": "Total number of items in the report."
},
"page": {
"$ref": "#/components/schemas/Page"
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date to generate report specific period."
},
"start_date": {
"type": "string",
"format": "date",
"description": "The start date to generate report specific period."
},
"items": {
"type": "array",
"description": "Nested array structure representing report items or data.",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
},
"headers": {
"type": "array",
"description": "Headers describing each item in the report data.",
"items": {
"type": "string"
}
},
"primary_headers": {
"type": "array",
"description": "Primary headers describing each item in the report data.",
"items": {
"type": "string"
}
},
"allowed_filters": {
"type": "array",
"description": "Filters allowed for the report data.",
"items": {
"type": "string"
}
},
"row_header_display_order": {
"type": "object",
"additionalProperties": true,
"description": "Indicates the order in which the headers are to be displayed."
}
}

🔹 Change 10​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportJson
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.generateReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.item_count

🔹 Change 11​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportJson
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.generateReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page

🔹 Change 12​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportJson
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.generateReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.end_date

🔹 Change 13​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportJson
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.generateReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.start_date

🔹 Change 14​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportJson
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.generateReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items

🔹 Change 15​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportJson
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.generateReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.headers

🔹 Change 16​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.generateReport.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.status.nullable
  • New Schema:
true

🔹 Change 17​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.generateReport.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message.nullable
  • New Schema:
true

🔹 Change 18​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.generateReport.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.exception.nullable
  • New Schema:
true

🔧 Operation: downloadReport​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReport.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.start_date.format
  • New Schema:
"date"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReport.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.end_date.format
  • New Schema:
"date"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.start_date.format
  • New Schema:
"date"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.end_date.format
  • New Schema:
"date"

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportPlatform --> GenerateReportPlatform/properties --> GenerateReportPlatform/properties/meta --> GenerateReportMeta --> GenerateReportPlatform/properties/meta/properties --> GenerateReportPlatform/properties/meta/properties/brand
  • Schema Action: NULLABLE_ADDED
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.meta.properties.brand.nullable
  • New Schema:
true

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportPlatform --> GenerateReportPlatform/properties --> GenerateReportPlatform/properties/meta --> GenerateReportMeta --> GenerateReportPlatform/properties/meta/properties --> GenerateReportPlatform/properties/meta/properties/company
  • Schema Action: NULLABLE_ADDED
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.meta.properties.company.nullable
  • New Schema:
true

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportPlatform --> GenerateReportPlatform/properties --> GenerateReportPlatform/properties/meta --> GenerateReportMeta --> GenerateReportPlatform/properties/meta/properties --> GenerateReportPlatform/properties/meta/properties/channel
  • Schema Action: NULLABLE_ADDED
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.meta.properties.channel.nullable
  • New Schema:
true

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportPlatform --> GenerateReportPlatform/properties --> GenerateReportPlatform/properties/filters --> GenerateReportFilters --> GenerateReportPlatform/properties/filters/properties --> GenerateReportPlatform/properties/filters/properties/brand
  • Schema Action: NULLABLE_ADDED
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.filters.properties.brand.nullable
  • New Schema:
true

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportPlatform --> GenerateReportPlatform/properties --> GenerateReportPlatform/properties/filters --> GenerateReportFilters --> GenerateReportPlatform/properties/filters/properties --> GenerateReportPlatform/properties/filters/properties/company
  • Schema Action: NULLABLE_ADDED
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.filters.properties.company.nullable
  • New Schema:
true

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportPlatform --> GenerateReportPlatform/properties --> GenerateReportPlatform/properties/filters --> GenerateReportFilters --> GenerateReportPlatform/properties/filters/properties --> GenerateReportPlatform/properties/filters/properties/channel
  • Schema Action: NULLABLE_ADDED
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.filters.properties.channel.nullable
  • New Schema:
true

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/items --> DownloadReportList/properties/items/items --> DownloadReportItems --> DownloadReportList/properties/items/items/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.display_name
  • New Schema:
{
"type": "string",
"description": "The display name of the report item."
}

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/items --> DownloadReportList/properties/items/items --> DownloadReportItems --> DownloadReportList/properties/items/items/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_at
  • New Schema:
{
"type": "string",
"format": "date-time",
"description": "The timestamp when the report item was created, formatted as a string."
}

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/items --> DownloadReportList/properties/items/items --> DownloadReportItems --> DownloadReportList/properties/items/items/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.status
  • New Schema:
{
"type": "string",
"description": "The current status of the report item (e.g., 'Completed', 'Pending')."
}

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/items --> DownloadReportList/properties/items/items --> DownloadReportItems --> DownloadReportList/properties/items/items/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.msg
  • New Schema:
{
"type": "string",
"nullable": true,
"description": "A message associated with the report item."
}

🔹 Change 15​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/items --> DownloadReportList/properties/items/items --> DownloadReportItems --> DownloadReportList/properties/items/items/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.download_link
  • New Schema:
{
"type": "string",
"nullable": true,
"description": "The link to download the report item, if available."
}

🔹 Change 16​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/items --> DownloadReportList/properties/items/items --> DownloadReportItems --> DownloadReportList/properties/items/items/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.full_name
  • New Schema:
{
"type": "string",
"description": "The full name of the user who requested the report."
}

🔹 Change 17​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/items --> DownloadReportList/properties/items/items --> DownloadReportItems --> DownloadReportList/properties/items/items/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.request_dict
  • New Schema:
{
"type": "object",
"additionalProperties": true,
"description": "The dictionary containing the request parameters."
}

🔹 Change 18​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/items --> DownloadReportList/properties/items/items --> DownloadReportItems --> DownloadReportList/properties/items/items/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.report_config_id
  • New Schema:
{
"type": "string",
"description": "The configuration ID of the report."
}

🔹 Change 19​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/items --> DownloadReportList/properties/items/items --> DownloadReportItems --> DownloadReportList/properties/items/items/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.report_name
  • New Schema:
{
"type": "string",
"description": "The name of the report."
}

🔹 Change 20​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/items --> DownloadReportList/properties/items/items --> DownloadReportItems --> DownloadReportList/properties/items/items/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.requested_by
  • New Schema:
{
"type": "string",
"description": "The user who requested the report."
}

🔹 Change 21​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/items --> DownloadReportList/properties/items/items --> DownloadReportItems --> DownloadReportList/properties/items/items/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.type_of_request
  • New Schema:
{
"type": "string",
"description": "The type of request for the report item (e.g., 'Automatic', 'Manual')."
}

🔹 Change 22​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/page --> Page --> DownloadReportList/properties/page/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 23​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReport.methodTypePlaceHolder.responses.400

🔧 Operation: getData​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetEngineRequestSchema --> GetEngineData
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.getData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.search.additionalProperties
  • New Schema:
true

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/page --> Page --> DownloadReportList/properties/page/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getData.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getData.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.status.nullable
  • New Schema:
true

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getData.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message.nullable
  • New Schema:
true

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getData.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.exception.nullable
  • New Schema:
true

🔧 Operation: getReason​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/page --> Page --> DownloadReportList/properties/page/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getReason.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getReason.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.status.nullable
  • New Schema:
true

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getReason.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message.nullable
  • New Schema:
true

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getReason.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.exception.nullable
  • New Schema:
true

🔧 Operation: getReportList​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetReportListResponseSchema --> ReportItem
  • Schema Action: ENUM_ADDED
  • Path: paths.getReportList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.report_type.enum
  • New Schema:
[
"csv",
"json"
]

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/page --> Page --> DownloadReportList/properties/page/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getReportList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getReportList.methodTypePlaceHolder.responses.500

🔧 Operation: paymentProcess​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentProcessRequestSchema --> PaymentProcessPayload
  • Schema Action: ENUM_ADDED
  • Path: paths.paymentProcess.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.transaction_type.enum
  • New Schema:
[
"seller_online",
"admin_offline"
]

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentProcessRequestSchema --> PaymentProcessPayload
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.paymentProcess.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.meta.additionalProperties
  • New Schema:
true

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.paymentProcess.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.status.nullable
  • New Schema:
true

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.paymentProcess.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message.nullable
  • New Schema:
true

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.paymentProcess.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.exception.nullable
  • New Schema:
true

🔧 Operation: creditlineDataplatform​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.creditlineDataplatform.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.end_date.format
  • New Schema:
"date"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.creditlineDataplatform.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.start_date.format
  • New Schema:
"date"

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/page --> Page --> DownloadReportList/properties/page/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.creditlineDataplatform.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.creditlineDataplatform.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.status.nullable
  • New Schema:
true

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.creditlineDataplatform.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message.nullable
  • New Schema:
true

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.creditlineDataplatform.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.exception.nullable
  • New Schema:
true

🔧 Operation: invoiceListing​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.invoiceListing.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.start_date.format
  • New Schema:
"date-time"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.invoiceListing.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.end_date.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.invoiceListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.due_date.format
  • New Schema:
"date"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.invoiceListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.invoice_date.format
  • New Schema:
"date"

🔹 Change 5​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: InvoiceListingResponseSchema --> InvoiceListingResponseItems
  • Schema Action: ENUM_ADDED
  • Path: paths.invoiceListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.invoice_type.enum
  • New Schema:
[
"Seller Fynd",
"Platform Subscription",
"Seller Invoice Fynd"
]

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: InvoiceListingResponseSchema --> InvoiceListingResponseItems
  • Schema Action: PROPERTY_ADDED
  • Path: paths.invoiceListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.source_id
  • New Schema:
{
"type": "string",
"nullable": true,
"description": "The unique identifier of the source."
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/page --> Page --> DownloadReportList/properties/page/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.invoiceListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.invoiceListing.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.status.nullable
  • New Schema:
true

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.invoiceListing.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message.nullable
  • New Schema:
true

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.invoiceListing.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.exception.nullable
  • New Schema:
true

🔹 Change 11​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.invoiceListing.methodTypePlaceHolder.responses.500

🔧 Operation: invoicePDF​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.invoicePDF.methodTypePlaceHolder.responses.500

🔧 Operation: isCnRefundMethod​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: IsCnRefundMethodRequestSchema --> IsCnRefundMethodData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.isCnRefundMethod.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.issuance_ordering_channels
  • New Schema:
{
"type": "array",
"description": "The channel through which the order was placed.",
"items": {
"type": "string"
}
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.isCnRefundMethod.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.status.nullable
  • New Schema:
true

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.isCnRefundMethod.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message.nullable
  • New Schema:
true

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.isCnRefundMethod.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.exception.nullable
  • New Schema:
true

🔧 Operation: createSellerCreditNoteConfig​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateSellerCreditNoteConfigReq --> CreateSellerCreditNoteConfig
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.createSellerCreditNoteConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.source_channel

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateSellerCreditNoteConfigReq --> CreateSellerCreditNoteConfig
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.createSellerCreditNoteConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.ordering_channel

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateSellerCreditNoteConfigRequestSchema --> CreateSellerCreditNoteConfig
  • Schema Action: ENUM_ADDED
  • Path: paths.createSellerCreditNoteConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.currency_type.enum
  • New Schema:
[
"INR",
"USD"
]

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateSellerCreditNoteConfigRequestSchema --> CreateSellerCreditNoteConfig
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createSellerCreditNoteConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.issuance_ordering_channels
  • New Schema:
{
"type": "array",
"description": "List of source channels associated with the credit note configuration.",
"items": {
"type": "string"
}
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateSellerCreditNoteConfigRequestSchema --> CreateSellerCreditNoteConfig
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createSellerCreditNoteConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.redemption_ordering_channels
  • New Schema:
{
"type": "array",
"description": "List of ordering channels associated with the credit note configuration.",
"items": {
"type": "string"
}
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.createSellerCreditNoteConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.status.nullable
  • New Schema:
true

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.createSellerCreditNoteConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message.nullable
  • New Schema:
true

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.createSellerCreditNoteConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.exception.nullable
  • New Schema:
true

🔧 Operation: deleteConfig​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.deleteConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.status.nullable
  • New Schema:
true

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.deleteConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message.nullable
  • New Schema:
true

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.deleteConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.exception.nullable
  • New Schema:
true

🔧 Operation: getPdfUrlView​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getPdfUrlView.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.status.nullable
  • New Schema:
true

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getPdfUrlView.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message.nullable
  • New Schema:
true

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getPdfUrlView.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.exception.nullable
  • New Schema:
true

🔧 Operation: creditNoteDetails​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreditNoteDetails --> CreditNoteDetails/properties --> CreditNoteDetails/properties/cn_details --> CnDetails --> CreditNoteDetails/properties/cn_details/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.creditNoteDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.cn_details.properties.issuance_ordering_channel
  • New Schema:
{
"type": "string",
"description": "Channel through which the credit note was issued.",
"example": "ecomm"
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreditNoteDetails --> CreditNoteDetails/properties --> CreditNoteDetails/properties/redemption_details --> CreditNoteDetails/properties/redemption_details/items --> RedemptionDetails --> CreditNoteDetails/properties/redemption_details/items/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.creditNoteDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.redemption_details.items.properties.redemption_ordering_channel
  • New Schema:
{
"type": "string",
"description": "Channel through which the credit note was issued.",
"example": "ecomm"
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreditNoteDetailsResponseSchema --> CreditNoteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.creditNoteDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.customer_email_id
  • New Schema:
{
"type": "string",
"description": "Email of the customer whose credit balance is being requested.",
"example": "test@example.com"
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.creditNoteDetails.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.status.nullable
  • New Schema:
true

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.creditNoteDetails.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message.nullable
  • New Schema:
true

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.creditNoteDetails.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.exception.nullable
  • New Schema:
true

🔧 Operation: getCustomerCreditBalance​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCustomerCreditBalanceRequestSchema --> GetCustomerCreditBalance
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCustomerCreditBalance.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.customer_email
  • New Schema:
{
"type": "string",
"description": "Email of the customer whose credit balance is being requested.",
"example": "test@example.com"
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCustomerCreditBalanceResponseSchema --> GetCustomerCreditBalanceResponseData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCustomerCreditBalance.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.customer_email
  • New Schema:
{
"type": "string",
"description": "Email of the customer whose credit balance is being requested.",
"example": "test@example.com"
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getCustomerCreditBalance.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.status.nullable
  • New Schema:
true

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getCustomerCreditBalance.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message.nullable
  • New Schema:
true

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getCustomerCreditBalance.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.exception.nullable
  • New Schema:
true

🔧 Operation: getCnConfig​

🔹 Change 1​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCnConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.meta.oneOf

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCnConfigResponseSchema --> GetCnConfigResponseData --> GetCnConfigResponseMeta
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.getCnConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.meta.type
  • New Schema:
"object"

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCnConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.meta.properties
  • New Schema:
{
"reason": {
"type": "string",
"nullable": true,
"description": "Reason associated with the configuration response."
},
"currency": {
"type": "object",
"additionalProperties": true,
"description": "Type of currency used for the credit note.",
"example": {}
}
}

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCnConfigResponse --> GetCnConfigResponseData
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getCnConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.redemption_ordering_channel

🔹 Change 5​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCnConfigResponseSchema --> GetCnConfigResponseData
  • Schema Action: ENUM_ADDED
  • Path: paths.getCnConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.currency_type.enum
  • New Schema:
[
"INR",
"USD"
]

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCnConfigResponseSchema --> GetCnConfigResponseData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCnConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.redemption_ordering_channels
  • New Schema:
{
"type": "array",
"description": "List of ordering channels associated with credit note redemption.",
"items": {
"type": "string"
}
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCnConfigResponseSchema --> GetCnConfigResponseData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCnConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.issuance_ordering_channels
  • New Schema:
{
"type": "array",
"description": "List of ordering channels associated with credit note redemption.",
"items": {
"type": "string"
}
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCnConfigResponseSchema --> GetCnConfigResponseData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCnConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.created_at
  • New Schema:
{
"type": "string",
"format": "date-time",
"description": "Timestamp when the configuration was created",
"example": "2024-07-16T07:03:49.956"
}

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getCnConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.status.nullable
  • New Schema:
true

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getCnConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message.nullable
  • New Schema:
true

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getCnConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.exception.nullable
  • New Schema:
true

🔧 Operation: generateReportCustomerCn​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.generateReportCustomerCn.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.end_date.format
  • New Schema:
"date"

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportPlatform --> GenerateReportPlatform/properties --> GenerateReportPlatform/properties/filters --> GenerateReportFilters --> GenerateReportPlatform/properties/filters/properties --> GenerateReportPlatform/properties/filters/properties/brand
  • Schema Action: NULLABLE_ADDED
  • Path: paths.generateReportCustomerCn.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.meta.properties.brand.nullable
  • New Schema:
true

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportPlatform --> GenerateReportPlatform/properties --> GenerateReportPlatform/properties/filters --> GenerateReportFilters --> GenerateReportPlatform/properties/filters/properties --> GenerateReportPlatform/properties/filters/properties/company
  • Schema Action: NULLABLE_ADDED
  • Path: paths.generateReportCustomerCn.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.meta.properties.company.nullable
  • New Schema:
true

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GenerateReportPlatform --> GenerateReportPlatform/properties --> GenerateReportPlatform/properties/filters --> GenerateReportFilters --> GenerateReportPlatform/properties/filters/properties --> GenerateReportPlatform/properties/filters/properties/channel
  • Schema Action: NULLABLE_ADDED
  • Path: paths.generateReportCustomerCn.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.meta.properties.channel.nullable
  • New Schema:
true

🔹 Change 5​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.generateReportCustomerCn.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.start_date.format
  • New Schema:
"date"

🔹 Change 6​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.generateReportCustomerCn.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.items.items.properties.expiry_date.format
  • New Schema:
"date"

🔹 Change 7​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.generateReportCustomerCn.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.items.items.properties.date_issued.format
  • New Schema:
"date"

🔹 Change 8​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.generateReportCustomerCn.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.end_date.format
  • New Schema:
"date"

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/page --> Page --> DownloadReportList/properties/page/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.generateReportCustomerCn.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 10​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.generateReportCustomerCn.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.start_date.format
  • New Schema:
"date"

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.generateReportCustomerCn.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.status.nullable
  • New Schema:
true

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.generateReportCustomerCn.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message.nullable
  • New Schema:
true

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.generateReportCustomerCn.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.exception.nullable
  • New Schema:
true

🔧 Operation: downloadReportCustomerCn​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportCustomerCn.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.start_date.format
  • New Schema:
"date"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportCustomerCn.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.end_date.format
  • New Schema:
"date"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportCustomerCn.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.start_date.format
  • New Schema:
"date"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportCustomerCn.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.end_date.format
  • New Schema:
"date"

🔹 Change 5​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportCustomerCn.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DownloadReportList --> DownloadReportList/properties --> DownloadReportList/properties/page --> Page --> DownloadReportList/properties/page/properties
  • Schema Action: PROPERTY_ADDED
  • Path: paths.downloadReportCustomerCn.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.downloadReportCustomerCn.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.status.nullable
  • New Schema:
true

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.downloadReportCustomerCn.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message.nullable
  • New Schema:
true

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: Error
  • Schema Action: NULLABLE_ADDED
  • Path: paths.downloadReportCustomerCn.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.exception.nullable
  • New Schema:
true

🔧 Operation: invoicePaymentOptions​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: InvoicePaymentOptionsResponse
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.invoicePaymentOptions.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: InvoicePaymentOptionsResponseSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.invoicePaymentOptions.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "List of data objects containing details about invoice payment options.",
"items": {
"$ref": "#/components/schemas/InvoicePaymentOptionsResponseData"
}
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.invoicePaymentOptions.methodTypePlaceHolder.responses.400
  • New Schema:
{
"description": "Bad request. See the error object in the response body to know the exact reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"examples": {
"status_400": {
"value": {
"success": false,
"reason": "body.data.app_id:Field required",
"message": "body.data.app_id:Field required",
"status": 400,
"code": null,
"exception": "RequestValidationError",
"info": null,
"request_id": null,
"stack_trace": null,
"meta": {
"columns_errors": [
{
"code": null,
"message": "body.data.app_id:Field required"
}
]
}
}
}
}
}
}
}

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.invoicePaymentOptions.methodTypePlaceHolder.responses.500

🔧 Operation: invoicePaymentDetails​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: InvoicePaymentDetailsResponseSchema
  • Schema Action: NULLABLE_ADDED
  • Path: paths.invoicePaymentDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.reason.nullable
  • New Schema:
true

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: InvoicePaymentDetailsResponse
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.invoicePaymentDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: InvoicePaymentDetailsResponse
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.invoicePaymentDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.success

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: InvoicePaymentDetailsResponseSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.invoicePaymentDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.paid_invoice_payment_details
  • New Schema:
{
"type": "array",
"description": "List of details for paid invoices.",
"items": {
"$ref": "#/components/schemas/PaidInvoicePaymentDetail"
}
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: InvoicePaymentDetailsResponseSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.invoicePaymentDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.failed_attempts_details
  • New Schema:
{
"type": "array",
"nullable": true,
"description": "Details of any failed payment attempts for the invoices.",
"items": {
"type": "object"
}
}

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.invoicePaymentDetails.methodTypePlaceHolder.responses.500

🔧 Operation: invoiceActivityLogs​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: InvoiceActivityLogsResponseSchema --> InvoiceActivityLogsResponseData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.invoiceActivityLogs.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.items.properties.action
  • New Schema:
{
"type": "string",
"description": "Name of the action logged (e.g., 'pending status', 'initial status').",
"nullable": true,
"example": "pending"
}

🔧 Operation: unlockCreditNote​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: UnlockCreditNoteReq --> UnlockCreditNoteRequestData
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.unlockCreditNote.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.locked_credit_notes

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UnlockCreditNoteRequestSchema --> UnlockCreditNoteRequestData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.unlockCreditNote.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties.locked_credit_note
  • New Schema:
{
"type": "string",
"description": "Credit note id which needs to be unlocked."
}

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: UnlockCreditNoteResponseSchema --> UnlockCreditNoteResponseData
  • Schema Action: ENUM_ADDED
  • Path: paths.unlockCreditNote.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.status.enum
  • New Schema:
[
"failed",
"completed"
]

🔧 Operation: orderFreeze​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: OrederFreezeResponse
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.orderFreeze.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.source.nullable

🔧 Operation: lockUnlockCreditNote​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.lockUnlockCreditNote
  • New Schema:
{
"methodTypePlaceHolder": {
"tags": [
"Finance"
],
"operationId": "lockUnlockCreditNote",
"summary": "Lock or Unlock requested credit note",
"description": "Used to lock or unlock requested credit note.",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "Company ID for which the data will be returned.Company_id is required.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"lock_200": {
"value": "100"
},
"lock_400": {
"value": "62"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LockUnlockRequestSchema"
},
"examples": {
"lock_200": {
"value": {
"data": {
"seller_id": 100,
"affiliate_id": "100",
"ordering_channel": "platform-pos",
"credit_note_number": "credit_note_test_exchange_6",
"amount": 10,
"request_type": "lock",
"order_id": "11111"
}
}
},
"lock_400": {
"value": {
"data": {
"seller_id": 1001,
"affiliate_id": "100",
"ordering_channel": "platform-pos",
"credit_note_number": "D00009907A000117",
"amount": 100,
"request_type": "lock",
"order_id": "11111"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LockUnlockResponseSchema"
},
"examples": {
"lock_200": {
"value": {
"success": true,
"data": {
"credit_note_number": "D00009907A000117",
"amount": 100
}
}
}
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body to know the exact reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"examples": {
"lock_400": {
"value": {
"success": false,
"reason": "body.data.app_id:Field required"
}
}
}
}
}
}
},
"x-groups": [
"Invoice and Credit Note Management"
],
"security": [
{
"oauth2": [
"company/finance/write"
]
}
],
"path": "/service/platform/finance/v1.0/company/{company_id}/lock-unlock-credit-note",
"methodType": "post"
}
}

Was this section helpful?