GET/v1/financial-catalog-itemsList Financial Catalog Items
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
q | query | string o nulo | No |
catalogKey | query | string o nulo | No |
category | query | string o nulo | No |
status | query | string o nulo | No |
includeInactive | query | boolean | No |
tenant_id | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de FinancialCatalogItemOut |
| 422 | Error de validación | HTTPValidationError |
/v1/financial-catalog-itemsCreate Financial Catalog Item
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenant_id | query | string o nulo | No |
Cuerpo obligatorio FinancialCatalogCreateIn
| Campo | Tipo | Obl. |
|---|
catalogKey | string | Sí |
parentItemId | string o nulo | No |
code | string | Sí |
name | string | Sí |
category | string | Sí |
amount | number o nulo | No |
percentage | number o nulo | No |
currency | string o nulo | No |
effectiveFrom | string (date-time) o nulo | No |
effectiveTo | string (date-time) o nulo | No |
notes | string o nulo | No |
status | string | No |
auditReason | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | FinancialCatalogItemOut |
| 422 | Error de validación | HTTPValidationError |
/v1/financial-catalog-items/consumerList Financial Catalog Consumer Items
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
catalogKey | query | string | Sí |
parentItemId | query | string o nulo | No |
q | query | string o nulo | No |
limit | query | integer | No |
tenant_id | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de FinancialCatalogItemOut |
| 422 | Error de validación | HTTPValidationError |
/v1/financial-catalog-items/maintenanceList Financial Catalog Maintenance
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
q | query | string o nulo | No |
catalogKey | query | string o nulo | No |
category | query | string o nulo | No |
status | query | string o nulo | No |
includeInactive | query | boolean | No |
page | query | integer | No |
pageSize | query | integer | No |
sortBy | query | string | No |
sortOrder | query | string | No |
tenant_id | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | FinancialCatalogMaintenanceListOut |
| 422 | Error de validación | HTTPValidationError |
/v1/financial-catalog-items/maintenance/bulk-statusBulk Update Financial Catalog Status
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenant_id | query | string o nulo | No |
Cuerpo obligatorio FinancialCatalogBulkStatusIn
| Campo | Tipo | Obl. |
|---|
itemIds | lista de string | Sí |
status | string | Sí |
auditReason | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | FinancialCatalogBulkStatusOut |
| 422 | Error de validación | HTTPValidationError |
/v1/financial-catalog-items/maintenance/exportExport Financial Catalog Maintenance
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenant_id | query | string o nulo | No |
Cuerpo obligatorio FinancialCatalogExportIn
| Campo | Tipo | Obl. |
|---|
q | string o nulo | No |
catalogKey | string o nulo | No |
category | string o nulo | No |
status | string o nulo | No |
includeInactive | boolean | No |
sortBy | string | No |
sortOrder | string | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | objeto |
| 422 | Error de validación | HTTPValidationError |
/v1/financial-catalog-items/{item_id}Get Financial Catalog Item
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
item_id | path | string | Sí |
tenant_id | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | FinancialCatalogItemOut |
| 422 | Error de validación | HTTPValidationError |
/v1/financial-catalog-items/{item_id}Update Financial Catalog Item
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
item_id | path | string | Sí |
tenant_id | query | string o nulo | No |
Cuerpo obligatorio FinancialCatalogUpdateIn
| Campo | Tipo | Obl. |
|---|
catalogKey | string o nulo | No |
parentItemId | string o nulo | No |
code | string o nulo | No |
name | string o nulo | No |
category | string o nulo | No |
amount | number o nulo | No |
percentage | number o nulo | No |
currency | string o nulo | No |
effectiveFrom | string (date-time) o nulo | No |
effectiveTo | string (date-time) o nulo | No |
notes | string o nulo | No |
status | string o nulo | No |
auditReason | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | FinancialCatalogItemOut |
| 422 | Error de validación | HTTPValidationError |
/v1/financial-catalog-items/{item_id}/historyList Financial Catalog Item History
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
item_id | path | string | Sí |
tenant_id | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de app__api__routes__financial_catalog__MaintenanceAuditEntryOut |
| 422 | Error de validación | HTTPValidationError |