Invoice Rejection Reason

Get A Resource By ID

HTTP Request

GET /api/v1/invoice-rejection-reasons/{id}

📋 Description: Retrieves the details of a specific invoice rejection reason identified by the provided ID, facilitating a clear understanding of the financial entity’s organizational structure and hierarchy.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseInvoiceRejectionReasonDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "rowNumber": 0,
17    "rowIdentifier": "string",
18    "errors": [
19      "string"
20    ],
21    "linkedErrors": [
22      "string"
23    ],
24    "warnings": [
25      "string"
26    ],
27    "remarks": [
28      "string"
29    ],
30    "skipMessage": "string",
31    "status": "CREATED",
32    "name": "string",
33    "displayId": "string"
34  }
35}

Update A Resource

HTTP Request

PUT /api/v1/invoice-rejection-reasons/{id}

📋 Description: Updates the specified invoice rejection reason within the financial organization structure, allowing for adjustments to the hierarchy and classification of financial entities. This operation ensures that the rejection reasons remain relevant and aligned with organizational policies.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

InvoiceRejectionReasonDto

true

Request body containing the updated invoice rejection reason data, including the rationale and associated metadata, to support organizational financial structure and hierarchy management.

Body Parameters

 1{
 2  "id": 0,
 3  "rowNumber": 0,
 4  "rowIdentifier": "string",
 5  "errors": [
 6    "string"
 7  ],
 8  "linkedErrors": [
 9    "string"
10  ],
11  "warnings": [
12    "string"
13  ],
14  "remarks": [
15    "string"
16  ],
17  "skipMessage": "string",
18  "status": "CREATED",
19  "name": "string",
20  "displayId": "string"
21}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseInvoiceRejectionReasonDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "rowNumber": 0,
17    "rowIdentifier": "string",
18    "errors": [
19      "string"
20    ],
21    "linkedErrors": [
22      "string"
23    ],
24    "warnings": [
25      "string"
26    ],
27    "remarks": [
28      "string"
29    ],
30    "skipMessage": "string",
31    "status": "CREATED",
32    "name": "string",
33    "displayId": "string"
34  }
35}

Delete

HTTP Request

DELETE /api/v1/invoice-rejection-reasons/{id}

📋 Description: Deletes a specified invoice rejection reason from the financial organization structure, ensuring the integrity of the hierarchy within the financial entity.

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

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Bulk Create-Or-Update Resources

HTTP Request

PUT /api/v1/invoice-rejection-reasons/createOrUpdate/bulk

📋 Description: Creates or updates multiple invoice rejection reasons in bulk, allowing financial organizations to efficiently manage their hierarchy and structure related to invoice processing.

Parameters

Name

In

Type

Required

Description

body

body

InvoiceRejectionReasonDto

true

Request body containing a list of invoice rejection reasons, including their associated identifiers and descriptions, to facilitate bulk creation or updates within the financial organization structure.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "rowNumber": 0,
 5    "rowIdentifier": "string",
 6    "errors": [
 7      "string"
 8    ],
 9    "linkedErrors": [
10      "string"
11    ],
12    "warnings": [
13      "string"
14    ],
15    "remarks": [
16      "string"
17    ],
18    "skipMessage": "string",
19    "status": "CREATED",
20    "name": "string",
21    "displayId": "string"
22  }
23]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListInvoiceRejectionReasonDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "rowNumber": 0,
18      "rowIdentifier": "string",
19      "errors": [
20        "string"
21      ],
22      "linkedErrors": [
23        "string"
24      ],
25      "warnings": [
26        "string"
27      ],
28      "remarks": [
29        "string"
30      ],
31      "skipMessage": "string",
32      "status": "CREATED",
33      "name": "string",
34      "displayId": "string"
35    }
36  ]
37}

Create Or Update A Resource

HTTP Request

PUT /api/v1/invoice-rejection-reasons/createOrUpdate

📋 Description: Creates or updates rejection reasons for invoices within the financial organization structure, ensuring alignment with the hierarchical framework of financial entities.

Parameters

Name

In

Type

Required

Description

body

body

InvoiceRejectionReasonDto

true

Request body containing the details of invoice rejection reasons, including identifiers and descriptions, to support the financial organization’s hierarchy and structure.

Body Parameters

 1{
 2  "id": 0,
 3  "rowNumber": 0,
 4  "rowIdentifier": "string",
 5  "errors": [
 6    "string"
 7  ],
 8  "linkedErrors": [
 9    "string"
10  ],
11  "warnings": [
12    "string"
13  ],
14  "remarks": [
15    "string"
16  ],
17  "skipMessage": "string",
18  "status": "CREATED",
19  "name": "string",
20  "displayId": "string"
21}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseInvoiceRejectionReasonDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "rowNumber": 0,
17    "rowIdentifier": "string",
18    "errors": [
19      "string"
20    ],
21    "linkedErrors": [
22      "string"
23    ],
24    "warnings": [
25      "string"
26    ],
27    "remarks": [
28      "string"
29    ],
30    "skipMessage": "string",
31    "status": "CREATED",
32    "name": "string",
33    "displayId": "string"
34  }
35}

Bulk-Update Resources

HTTP Request

PUT /api/v1/invoice-rejection-reasons/bulk

📋 Description: Updates multiple invoice rejection reasons in bulk for a specified financial organization structure, ensuring consistency and accuracy within the hierarchy of financial entities.

Parameters

Name

In

Type

Required

Description

body

body

InvoiceRejectionReasonDto

true

Request body containing a list of invoice rejection reasons to be updated in bulk, reflecting the organization’s financial hierarchy and structure.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "rowNumber": 0,
 5    "rowIdentifier": "string",
 6    "errors": [
 7      "string"
 8    ],
 9    "linkedErrors": [
10      "string"
11    ],
12    "warnings": [
13      "string"
14    ],
15    "remarks": [
16      "string"
17    ],
18    "skipMessage": "string",
19    "status": "CREATED",
20    "name": "string",
21    "displayId": "string"
22  }
23]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListInvoiceRejectionReasonDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "rowNumber": 0,
18      "rowIdentifier": "string",
19      "errors": [
20        "string"
21      ],
22      "linkedErrors": [
23        "string"
24      ],
25      "warnings": [
26        "string"
27      ],
28      "remarks": [
29        "string"
30      ],
31      "skipMessage": "string",
32      "status": "CREATED",
33      "name": "string",
34      "displayId": "string"
35    }
36  ]
37}

Bulk Create

HTTP Request

POST /api/v1/invoice-rejection-reasons/bulk

📋 Description: Submits multiple invoice rejection reasons in bulk for a financial organization, enabling efficient management of hierarchical structures within the entity.

Parameters

Name

In

Type

Required

Description

body

body

InvoiceRejectionReasonDto

true

Request body containing a list of invoice rejection reasons, including associated metadata, to facilitate bulk updates within the financial organization structure.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "rowNumber": 0,
 5    "rowIdentifier": "string",
 6    "errors": [
 7      "string"
 8    ],
 9    "linkedErrors": [
10      "string"
11    ],
12    "warnings": [
13      "string"
14    ],
15    "remarks": [
16      "string"
17    ],
18    "skipMessage": "string",
19    "status": "CREATED",
20    "name": "string",
21    "displayId": "string"
22  }
23]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListInvoiceRejectionReasonDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "rowNumber": 0,
18      "rowIdentifier": "string",
19      "errors": [
20        "string"
21      ],
22      "linkedErrors": [
23        "string"
24      ],
25      "warnings": [
26        "string"
27      ],
28      "remarks": [
29        "string"
30      ],
31      "skipMessage": "string",
32      "status": "CREATED",
33      "name": "string",
34      "displayId": "string"
35    }
36  ]
37}

Bulk Delete

HTTP Request

DELETE /api/v1/invoice-rejection-reasons/bulk

📋 Description: Deletes multiple invoice rejection reasons in bulk, streamlining the management of financial entity structures within the organization.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing an array of invoice rejection reason identifiers to facilitate the bulk deletion of specified financial entity records within the organizational structure.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Search Resources

HTTP Request

POST /api/v1/invoice-rejection-reasons/search

📋 Description: Submits a request to search for invoice rejection reasons within the financial organization structure, enabling users to identify specific reasons related to organizational hierarchy and financial entity operations.

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

InvoiceRejectionReasonDtoFilter

false

Request body containing the criteria for searching invoice rejection reasons within the financial organization structure, including relevant organizational hierarchy and entity details.

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

Body Parameters

 1{
 2  "idIn": [
 3    0
 4  ],
 5  "idEqual": 0,
 6  "idLike": "string",
 7  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 8  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdByLike": "string",
10  "createdByEqual": "string",
11  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedByLike": "string",
14  "modifiedByEqual": "string",
15  "uiSelector": "string",
16  "statusIn": [
17    "CREATED"
18  ],
19  "nameLike": "string",
20  "displayIdLike": "string"
21}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageInvoiceRejectionReasonDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "rowNumber": 0,
22      "rowIdentifier": "string",
23      "errors": [
24        "string"
25      ],
26      "linkedErrors": [
27        "string"
28      ],
29      "warnings": [
30        "string"
31      ],
32      "remarks": [
33        "string"
34      ],
35      "skipMessage": "string",
36      "status": "CREATED",
37      "name": "string",
38      "displayId": "string"
39    }
40  ],
41  "number": 0,
42  "sort": {
43    "unsorted": true,
44    "sorted": true,
45    "empty": true
46  },
47  "first": true,
48  "last": true,
49  "empty": true
50}

List All Resources

HTTP Request

GET /api/v1/invoice-rejection-reasons

📋 Description: Retrieves a list of invoice rejection reasons relevant to the financial organization structure, enabling users to understand the hierarchy and organizational context behind invoice processing decisions.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the invoice rejection reasons should be returned in a paginated format, facilitating efficient navigation through the financial organization structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageInvoiceRejectionReasonDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "rowNumber": 0,
22      "rowIdentifier": "string",
23      "errors": [
24        "string"
25      ],
26      "linkedErrors": [
27        "string"
28      ],
29      "warnings": [
30        "string"
31      ],
32      "remarks": [
33        "string"
34      ],
35      "skipMessage": "string",
36      "status": "CREATED",
37      "name": "string",
38      "displayId": "string"
39    }
40  ],
41  "number": 0,
42  "sort": {
43    "unsorted": true,
44    "sorted": true,
45    "empty": true
46  },
47  "first": true,
48  "last": true,
49  "empty": true
50}

Create

HTTP Request

POST /api/v1/invoice-rejection-reasons

📋 Description: Submits a new invoice rejection reason within the financial organization structure, facilitating the management of hierarchical financial entities and enhancing clarity in invoice processing.

Parameters

Name

In

Type

Required

Description

body

body

InvoiceRejectionReasonDto

true

Request body containing the reasons for rejecting invoices, including relevant identifiers and descriptions to support financial entity hierarchy and organizational structure.

Body Parameters

 1{
 2  "id": 0,
 3  "rowNumber": 0,
 4  "rowIdentifier": "string",
 5  "errors": [
 6    "string"
 7  ],
 8  "linkedErrors": [
 9    "string"
10  ],
11  "warnings": [
12    "string"
13  ],
14  "remarks": [
15    "string"
16  ],
17  "skipMessage": "string",
18  "status": "CREATED",
19  "name": "string",
20  "displayId": "string"
21}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseInvoiceRejectionReasonDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "rowNumber": 0,
17    "rowIdentifier": "string",
18    "errors": [
19      "string"
20    ],
21    "linkedErrors": [
22      "string"
23    ],
24    "warnings": [
25      "string"
26    ],
27    "remarks": [
28      "string"
29    ],
30    "skipMessage": "string",
31    "status": "CREATED",
32    "name": "string",
33    "displayId": "string"
34  }
35}

Get Metadata

HTTP Request

GET /api/v1/invoice-rejection-reasons/meta

📋 Description: Retrieves metadata for invoice rejection reasons within the financial organization structure, providing insights into the hierarchy and classifications relevant to financial entities.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  "STATUS"
3]

Response Schema