Vendor Request Partner CompanyΒΆ

Get A Resource By IDΒΆ

HTTP Request

GET /api/v1/vendor-request-partner-company/{id}

πŸ“‹ Description: Returns the single resource with the given ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Resource ID

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVendorRequestPartnerCompanyDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Update A ResourceΒΆ

HTTP Request

PUT /api/v1/vendor-request-partner-company/{id}

πŸ“‹ Description: Fully replaces the resource with the given ID. All fields in the request body are applied.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Resource ID

body

body

VendorRequestPartnerCompanyDto

true

Request body containing the updated vendor partnership details, including company information and relevant attributes for the specified partner.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVendorRequestPartnerCompanyDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Delete A Single ResourceΒΆ

HTTP Request

DELETE /api/v1/vendor-request-partner-company/{id}

πŸ“‹ Description: Permanently deletes the resource with the given ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Partially Update A Resource (Json Patch)ΒΆ

HTTP Request

PATCH /api/v1/vendor-request-partner-company/{id}

πŸ“‹ Description: Applies a JSON Patch (RFC 6902) document to the resource with the given ID. Only the fields specified in the patch are modified; all other fields remain unchanged.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

JsonPatch

true

Request body containing updated vendor partnership details, including company information and relevant attributes for the specified vendor ID.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVendorRequestPartnerCompanyDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Bulk Create-Or-Update ResourcesΒΆ

HTTP Request

PUT /api/v1/vendor-request-partner-company/createOrUpdate/bulk

πŸ“‹ Description: Creates or updates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are persisted; failed items are recorded in the response errors list. The response body always contains the successfully processed items alongside any per-item errors.

Parameters

Name

In

Type

Required

Description

body

body

VendorRequestPartnerCompanyDto

true

Request body containing a list of vendor partner company details for bulk creation or update, including necessary identifiers and associated metadata.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListVendorRequestPartnerCompanyDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Create Or Update A ResourceΒΆ

HTTP Request

PUT /api/v1/vendor-request-partner-company/createOrUpdate

πŸ“‹ Description: Creates the resource if no matching record exists, or fully updates it if one is found. Idempotent: safe to call multiple times with the same payload.

Parameters

Name

In

Type

Required

Description

body

body

VendorRequestPartnerCompanyDto

true

Request body containing the vendor partner company details, including identification, contact information, and relevant business attributes for creation or update purposes.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVendorRequestPartnerCompanyDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Bulk-Update ResourcesΒΆ

HTTP Request

PUT /api/v1/vendor-request-partner-company/bulk

πŸ“‹ Description: Updates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are updated; failed items are recorded in the response errors list. The response body always contains the successfully updated items alongside any per-item errors.

Parameters

Name

In

Type

Required

Description

body

body

VendorRequestPartnerCompanyDto

true

Request body containing a collection of vendor partnership details for bulk processing, including company identifiers and relevant attributes.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListVendorRequestPartnerCompanyDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Bulk-Create ResourcesΒΆ

HTTP Request

POST /api/v1/vendor-request-partner-company/bulk

πŸ“‹ Description: Creates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are persisted; failed items are recorded in the response errors list. The response body always contains the successfully created items alongside any per-item errors.

Parameters

Name

In

Type

Required

Description

body

body

VendorRequestPartnerCompanyDto

true

Request body containing a collection of vendor partnership details, including company information and relevant metadata for bulk processing.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListVendorRequestPartnerCompanyDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Bulk-Delete ResourcesΒΆ

HTTP Request

DELETE /api/v1/vendor-request-partner-company/bulk

πŸ“‹ Description: Deletes multiple resources by ID in a single request. Partial success: each deletion is attempted independently. If one or more deletions fail (e.g. due to state constraints), the successfully deleted items are NOT rolled back. A ValidationException containing per-item errors is thrown after all items have been attempted, so the caller must inspect the error list to determine which IDs were not deleted.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing an array of vendor request IDs to be processed for bulk deletion.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Search ResourcesΒΆ

HTTP Request

POST /api/v1/vendor-request-partner-company/search

πŸ“‹ Description: Returns a paginated list of resources matching the given filter criteria. Pass null or an empty body to return all accessible records.

Parameters

Name

In

Type

Required

Description

page

query

integer

false

Zero-based page index (0..N)

size

query

integer

false

The size of the page to be returned

sort

query

array[string]

false

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

body

body

VendorRequestPartnerCompanyDtoFilter

false

Request body containing the search criteria and filters for vendor partnership inquiries, enabling efficient retrieval of relevant partner company information.

Default ValuesΒΆ

Parameter

Default

Type

page

0

query

size

100

query

sort

["createdAt,ASC"]

query

Parameter ConstraintsΒΆ

Parameter

Constraints

page

Min: 0

size

Min: 1

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageVendorRequestPartnerCompanyDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

List All ResourcesΒΆ

HTTP Request

GET /api/v1/vendor-request-partner-company

πŸ“‹ Description: Returns a paginated list of all accessible resources ordered by ID. Prefer POST /search for filtered queries.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results should be returned in a paginated format, allowing for efficient data retrieval and management of large datasets.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageVendorRequestPartnerCompanyDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Create A ResourceΒΆ

HTTP Request

POST /api/v1/vendor-request-partner-company

πŸ“‹ Description: Creates a single resource. Returns the created resource with its generated ID.

Parameters

Name

In

Type

Required

Description

body

body

VendorRequestPartnerCompanyDto

true

Request body containing the vendor partnership details, including company information, contact details, and partnership terms.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVendorRequestPartnerCompanyDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto