2.0info: 1.2.0 fixation_proposal x-senior-domain: Agro x-senior-domain-path: agro x-senior-service-path: fixation_proposal contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/agrosecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /fixation_proposal/queries/healthcheck: post: description: Health Check tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: object allOf: – #/definitions/checkData description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Health Check tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: object allOf: – #/definitions/checkData description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fixation_proposal/queries/listProposalFixation: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: array items: type: object allOf: – #/definitions/payloadFilterProposal description: responses: 200: description: Ok schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/payloadProposal minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fixation_proposal/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fixation_proposal/queries/exportProposal: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fixation_proposal/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fixation_proposal/actions/createProposalFixation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/payloadProposal minimum: 1 description: responses: 200: description: Ok schema: type: object required: – response properties: response: type: array items: type: object allOf: – #/definitions/payloadResponseProposal minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fixation_proposal/actions/cancelProposalFixation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/payloadCancelProposal minimum: 1 description: responses: 200: description: Ok schema: type: object required: – response properties: response: type: array items: type: object allOf: – #/definitions/payloadResponseProposal minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fixation_proposal/actions/updateProposalFixation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/payloadProposal minimum: 1 description: responses: 200: description: Ok schema: type: object required: – response properties: response: type: array items: type: object allOf: – #/definitions/payloadResponseProposal minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fixation_proposal/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fixation_proposal/actions/importProposal: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fixation_proposal/events/importProposalEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fixation_proposal/events/exportProposalEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fixation_proposal/entities/proposal: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/proposal responses: 200: description: The created resource schema: #/definitions/proposal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/proposal responses: 200: description: The created resource schema: #/definitions/proposal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/proposal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fixation_proposal/entities/proposal/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editProposal responses: 200: description: Ok schema: #/definitions/editProposal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/proposal responses: 200: description: Ok schema: #/definitions/proposal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/proposal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fixation_proposal/entities/proposal/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/proposal responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down typeSituation: type: string enum: – PENDING – PROCESSING – CLOSED – CANCELED – VALIDATION_ERROR typeSituationIntegration: type: string enum: – SENT – SUCCESS – ERROR typeAction: type: string enum: – CREATE – UPDATE – CANCEL userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck payloadProposal: description: type: object required: – codeCompany – codeBranch – numberExternal – situation – quantityFixation – valueFixation – items properties: codeCompany: type: integer format: int64 description: Código da Empresa codeBranch: type: integer format: int64 description: Código da Filial numberExternal: type: string maxLength: 250 description: Número Externo situation: type: string allOf: – #/definitions/typeSituation description: Situação da Proposta quantityFixation: type: number format: double description: Quantidade a ser fixada valueFixation: type: string description: Valor a ser fixado conditionPayment: type: string maxLength: 6 description: Código da Condição de Pagamento observation: type: string maxLength: 250 description: Observação da Proposta userApproval: type: integer format: int64 description: Código do Usuário Responsável pela Aprovação dateApproval: type: string format: date description: Data da Aprovação hourApproval: type: string description: Hora da Aprovação items: type: array items: type: object allOf: – #/definitions/payloadProposalItem minimum: 1 description: Itens da Proposta de Fixação de Preço payloadProposalItem: description: type: object required: – branchOrder – numberOrder – sequenceItemOrder – quantityRequested – valueRequested properties: branchOrder: type: integer format: int64 description: Código da Filial da Ordem de Compra numberOrder: type: integer format: int64 description: Número da Ordem de Compra sequenceItemOrder: type: integer format: int64 description: Sequência do Item da Ordem de Compra quantityRequested: type: number format: double description: Quantidade Solicitada valueRequested: type: string description: Valor Solicitado codeProduct: type: string maxLength: 14 description: Código do Produto codeDerivation: type: string maxLength: 7 description: Código da Derivação codeSupplier: type: integer format: int64 description: Código do Fornecedor branchContract: type: integer format: int64 description: Código da Filial do Contrato numberContract: type: integer format: int64 description: Número do Contrato dateCompetence: type: string format: date description: Data de Competência sequenceItemContract: type: integer format: int64 description: Sequência do Item do Contrato valueBonus: type: string description: Valor do Bônus percentageBonus: type: number format: double description: Porcentagem do Bônus codeTransgenic: type: string maxLength: 10 description: Código da Transgenia codeHarvest: type: string maxLength: 10 description: Código da Safra sequenceOrigin: type: integer format: int64 description: Sequência de Origem branchInvoice: type: integer format: int64 description: Código da Filial da Nota Fiscal supplierInvoice: type: integer format: int64 description: Código do Fornecedor da Nota Fiscal numberInvoice: type: integer format: int64 description: Número da Nota Fiscal seriesInvoice: type: string maxLength: 3 description: Série da Nota Fiscal sequenceItemInvoice: type: integer format: int64 description: Sequência do Item da Nota Fiscal numberInvoiceProducer: type: integer format: int64 description: Número da Nota Fiscal do Produtor seriesInvoiceProducer: type: string maxLength: 3 description: Série da Nota Fiscal do Produtor priceUnit: type: string description: Preço Unitário codeMoney: type: string maxLength: 3 description: Código da Moeda valueComplementary: type: string description: Valor Complementar valueQuote: type: string description: Valor da Cotação unitMeasure: type: string maxLength: 3 description: Unidade de Medida logs: type: array items: type: object allOf: – #/definitions/payloadProposalLog description: payloadProposalLog: description: type: object required: – message properties: message: type: string maxLength: 250 description: Mensagem de Log payloadResponseProposal: description: type: object required: – numberExternal – statusCode – message properties: numberExternal: type: string maxLength: 250 description: Número Externo statusCode: type: integer format: int64 description: Status Code message: type: string maxLength: 250 description: Mensagem de Retorno payloadCancelProposal: description: type: object required: – codeCompany – codeBranch – numberExternal – reasonCancellation properties: codeCompany: type: integer format: int64 description: Código da Empresa codeBranch: type: integer format: int64 description: Código da Filial numberExternal: type: string maxLength: 250 description: Número Externo reasonCancellation: type: string maxLength: 250 description: Motivo do Cancelamento payloadFilterProposal: description: type: object required: – codeCompany – codeBranch – numberExternal properties: codeCompany: type: integer format: int64 description: Código da Empresa codeBranch: type: integer format: int64 description: Código da Filial numberExternal: type: string maxLength: 250 description: Número Externo proposal: description: type: object required: – codeCompany – codeBranch – numberExternal properties: id: type: string format: uuid description: Identificador da Proposta de Fixação de Preço codeCompany: type: integer format: int64 description: Código da Empresa codeBranch: type: integer format: int64 description: Código da Filial numberExternal: type: string maxLength: 250 description: Número Externo typeAction: type: string allOf: – #/definitions/typeAction description: Ação situationIntegration: type: string allOf: – #/definitions/typeSituationIntegration description: Situação da Integração jsonProposal: type: string description: Json da Proposta jsonReturn: type: string description: Json do Retorno createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editProposal: type: object required: – id allOf: – #/definitions/proposal notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage