/
var
/
www
/
html
/
back
/
.scribe
/
endpoints
/
Upload File
HOME
name: payments description: '' endpoints: - httpMethods: - GET uri: 'api/v1/payments/{modelID}' metadata: groupName: payments groupDescription: '' subgroup: '' subgroupDescription: '' title: 'Список платежей' description: '' authenticated: true custom: [] headers: Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}' Content-Type: multipart/form-data Accept: application/json urlParameters: modelID: name: modelID description: '' required: true example: 1 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: modelID: 1 queryParameters: name: name: name description: '' required: false example: assumenda type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] payment_date_from: name: payment_date_from description: 'дата платежа' required: false example: deleniti type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] payment_date_to: name: payment_date_to description: 'дата платежа' required: false example: nisi type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] created_at_from: name: created_at_from description: 'дата создания' required: false example: dolor type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] created_at_to: name: created_at_to description: 'дата создания' required: false example: et type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] status: name: status description: '' required: false example: ut type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] contragent_id: name: contragent_id description: '' required: false example: rerum type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] payment_type: name: payment_type description: '' required: false example: aperiam type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] id: name: id description: '' required: false example: enim type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] sorting: name: sorting description: '[status=>ASC|DESC, user=>ASC|DESC, payment_date=>ASC|DESC, amount=>ASC|DESC, contragent=>ASC|DESC, article=>ASC|DESC, organization=>ASC|DESC]' required: false example: labore type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] project_id: name: project_id description: '' required: false example: ut type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] article_id: name: article_id description: '' required: false example: aut type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] creator_id: name: creator_id description: '' required: false example: provident type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] account_id: name: account_id description: '' required: false example: voluptatem type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] organization_id: name: organization_id description: '' required: false example: totam type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanQueryParameters: name: assumenda payment_date_from: deleniti payment_date_to: nisi created_at_from: dolor created_at_to: et status: ut contragent_id: rerum payment_type: aperiam id: enim sorting: labore project_id: ut article_id: aut creator_id: provident account_id: voluptatem organization_id: totam bodyParameters: [] cleanBodyParameters: [] fileParameters: [] responses: - status: 200 content: '{"message":null,"errors":null,"data":{"status":1,"data":[],"metadata":{"request_id":"","timestamp":""}},"status":true}' headers: [] description: Ok custom: [] responseFields: [] auth: - headers - Authorization - 'Bearer v154Ze3fa6cga86PbVhDdkE' controller: null method: null route: null custom: [] - httpMethods: - POST uri: 'api/v1/payments/{modelID}' metadata: groupName: payments groupDescription: '' subgroup: '' subgroupDescription: '' title: 'Создать новый платеж' description: '' authenticated: true custom: [] headers: Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}' Content-Type: multipart/form-data Accept: application/json urlParameters: modelID: name: modelID description: '' required: true example: 1 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: modelID: 1 queryParameters: [] cleanQueryParameters: [] bodyParameters: name: name: name description: name. required: true example: ut type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] payment_type: name: payment_type description: type. required: true example: est type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] payment_date: name: payment_date description: 'date. Must be a valid date in the format <code>Y-m-d</code>.' required: false example: '2025-06-03' type: string enumValues: [] exampleWasSpecified: false nullable: true custom: [] amount: name: amount description: 'amount. Must match the regex /^\d+(\.\d{1,2})?$/. Значение поля value не должно превышать 999999999999.99.' required: true example: 15 type: number enumValues: [] exampleWasSpecified: false nullable: false custom: [] files: name: files description: files. required: false example: - asperiores type: 'string[]' enumValues: [] exampleWasSpecified: false nullable: true custom: [] contragent_id: name: contragent_id description: 'contragent_id. The <code>id</code> of an existing record in the counterparties table.' required: true example: 12 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] account_id: name: account_id description: 'account_id. The <code>id</code> of an existing record in the accounts table.' required: false example: 14 type: integer enumValues: [] exampleWasSpecified: false nullable: true custom: [] organization_id: name: organization_id description: 'The <code>id</code> of an existing record in the organizations table.' required: false example: 6 type: integer enumValues: [] exampleWasSpecified: false nullable: true custom: [] distributions: name: distributions description: payment_distribution. required: false example: null type: object enumValues: [] exampleWasSpecified: false nullable: true custom: [] cleanBodyParameters: name: ut payment_type: est payment_date: '2025-06-03' amount: 15 files: - asperiores contragent_id: 12 account_id: 14 organization_id: 6 fileParameters: [] responses: - status: 200 content: '{"message":null,"errors":null,"data":{"status":1,"data":[],"metadata":{"request_id":"","timestamp":""}},"status":true}' headers: [] description: Ok custom: [] responseFields: [] auth: - headers - Authorization - 'Bearer gvheEk638aaZP61d5cVbfD4' controller: null method: null route: null custom: [] - httpMethods: - POST uri: 'api/v1/payments/{modelID}/{id}/status' metadata: groupName: payments groupDescription: '' subgroup: '' subgroupDescription: '' title: 'Сменить статус платежа' description: '' authenticated: true custom: [] headers: Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}' Content-Type: multipart/form-data Accept: application/json urlParameters: modelID: name: modelID description: '' required: true example: 1 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] id: name: id description: 'The ID of the {modelID}.' required: true example: enim type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: modelID: 1 id: enim queryParameters: [] cleanQueryParameters: [] bodyParameters: status: name: status description: status. required: true example: at type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] comment: name: comment description: Комментарий. required: false example: cumque type: string enumValues: [] exampleWasSpecified: false nullable: true custom: [] cleanBodyParameters: status: at comment: cumque fileParameters: [] responses: - status: 200 content: '{"message":null,"errors":null,"data":{"status":1,"data":[],"metadata":{"request_id":"","timestamp":""}},"status":true}' headers: [] description: Ok custom: [] responseFields: [] auth: - headers - Authorization - 'Bearer fk61853ZDac6ghEbePV4dva' controller: null method: null route: null custom: [] - httpMethods: - POST uri: 'api/v1/payments/{modelID}/{id}/status-update' metadata: groupName: payments groupDescription: '' subgroup: '' subgroupDescription: '' title: 'Сменить статус платежа по статусной модели' description: '' authenticated: true custom: [] headers: Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}' Content-Type: multipart/form-data Accept: application/json urlParameters: modelID: name: modelID description: '' required: true example: 1 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] id: name: id description: 'The ID of the {modelID}.' required: true example: omnis type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: modelID: 1 id: omnis queryParameters: move_to: name: move_to description: '=> [next, previous, rollback]' required: false example: et type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] comment: name: comment description: Комментарий required: false example: cumque type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanQueryParameters: move_to: et comment: cumque bodyParameters: [] cleanBodyParameters: [] fileParameters: [] responses: - status: 200 content: '{"message":null,"errors":null,"data":{"status":1,"data":[],"metadata":{"request_id":"","timestamp":""}},"status":true}' headers: [] description: Ok custom: [] responseFields: [] auth: - headers - Authorization - 'Bearer k6ac3d5VPDveg6aEh4b81fZ' controller: null method: null route: null custom: [] - httpMethods: - DELETE uri: 'api/v1/payments/{modelID}/{id}' metadata: groupName: payments groupDescription: '' subgroup: '' subgroupDescription: '' title: 'Удалить существующий платеж' description: '' authenticated: true custom: [] headers: Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}' Content-Type: multipart/form-data Accept: application/json urlParameters: modelID: name: modelID description: '' required: true example: 1 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] id: name: id description: 'The ID of the {modelID}.' required: true example: sit type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: modelID: 1 id: sit queryParameters: [] cleanQueryParameters: [] bodyParameters: [] cleanBodyParameters: [] fileParameters: [] responses: - status: 200 content: '{"message":null,"errors":null,"data":{"message":"ok"},"status":true}' headers: [] description: Ok custom: [] responseFields: [] auth: - headers - Authorization - 'Bearer ehD483g5ZcEa1Pb66kvafdV' controller: null method: null route: null custom: [] - httpMethods: - POST uri: 'api/v1/payments/{modelID}/{id}' metadata: groupName: payments groupDescription: '' subgroup: '' subgroupDescription: '' title: 'Обновить существующий платеж' description: '' authenticated: true custom: [] headers: Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}' Content-Type: multipart/form-data Accept: application/json urlParameters: modelID: name: modelID description: '' required: true example: 1 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] id: name: id description: 'The ID of the {modelID}.' required: true example: ut type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: modelID: 1 id: ut queryParameters: [] cleanQueryParameters: [] bodyParameters: name: name: name description: name. required: true example: veritatis type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] payment_type: name: payment_type description: type. required: true example: et type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] payment_date: name: payment_date description: 'date. Must be a valid date in the format <code>Y-m-d</code>.' required: false example: '2025-06-03' type: string enumValues: [] exampleWasSpecified: false nullable: true custom: [] amount: name: amount description: 'amount. Must match the regex /^\d+(\.\d{1,2})?$/. Значение поля value не должно превышать 999999999999.99.' required: true example: 4 type: number enumValues: [] exampleWasSpecified: false nullable: false custom: [] files: name: files description: files. required: false example: - odio type: 'string[]' enumValues: [] exampleWasSpecified: false nullable: true custom: [] contragent_id: name: contragent_id description: 'contragent_id. The <code>id</code> of an existing record in the counterparties table.' required: true example: 14 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] account_id: name: account_id description: 'account_id. The <code>id</code> of an existing record in the accounts table.' required: false example: 3 type: integer enumValues: [] exampleWasSpecified: false nullable: true custom: [] organization_id: name: organization_id description: 'The <code>id</code> of an existing record in the organizations table.' required: false example: 15 type: integer enumValues: [] exampleWasSpecified: false nullable: true custom: [] distributions: name: distributions description: payment_distribution. required: false example: null type: object enumValues: [] exampleWasSpecified: false nullable: true custom: [] cleanBodyParameters: name: veritatis payment_type: et payment_date: '2025-06-03' amount: 4 files: - odio contragent_id: 14 account_id: 3 organization_id: 15 fileParameters: [] responses: - status: 200 content: '{"message":null,"errors":null,"data":{"status":1,"data":[],"metadata":{"request_id":"","timestamp":""}},"status":true}' headers: [] description: Ok custom: [] responseFields: [] auth: - headers - Authorization - 'Bearer EVD8g64v1e5dfa3Z6Pbakch' controller: null method: null route: null custom: [] - httpMethods: - GET uri: 'api/v1/payments/{modelID}/{id}' metadata: groupName: payments groupDescription: '' subgroup: '' subgroupDescription: '' title: 'Платеж по ID' description: '' authenticated: true custom: [] headers: Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}' Content-Type: multipart/form-data Accept: application/json urlParameters: modelID: name: modelID description: '' required: true example: 1 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] id: name: id description: 'The ID of the {modelID}.' required: true example: omnis type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: modelID: 1 id: omnis queryParameters: [] cleanQueryParameters: [] bodyParameters: [] cleanBodyParameters: [] fileParameters: [] responses: - status: 200 content: '{"message":null,"errors":null,"data":{"status":1,"data":[],"metadata":{"request_id":"","timestamp":""}},"status":true}' headers: [] description: Ok custom: [] responseFields: [] auth: - headers - Authorization - 'Bearer ah6cakEP6vg8dVef345b1ZD' controller: null method: null route: null custom: [] - httpMethods: - GET uri: 'api/v1/payments/{modelID}/{id}/similar' metadata: groupName: payments groupDescription: '' subgroup: '' subgroupDescription: '' title: 'Похожие платежи' description: '' authenticated: true custom: [] headers: Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}' Content-Type: multipart/form-data Accept: application/json urlParameters: modelID: name: modelID description: '' required: true example: 1 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] id: name: id description: 'The ID of the {modelID}.' required: true example: accusamus type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: modelID: 1 id: accusamus queryParameters: [] cleanQueryParameters: [] bodyParameters: [] cleanBodyParameters: [] fileParameters: [] responses: - status: 200 content: '{"message":null,"errors":null,"data":{"status":1,"data":[],"metadata":{"request_id":"","timestamp":""}},"status":true}' headers: [] description: Ok custom: [] responseFields: [] auth: - headers - Authorization - 'Bearer 5EPZafkV34Dd1hce68bavg6' controller: null method: null route: null custom: []