contract

2.0info: 1.1.3 contract description: Contract x-senior-domain: Agro x-senior-domain-path: agro x-senior-service-path: contract 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: /contract/queries/findContractBalanceLink: post: description: Consulta os saldos do contrato para vinculo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – pageRequest properties: filter: type: object allOf: – #/definitions/filterEffectiveContract description: Filtros pageRequest: type: object allOf: – #/definitions/recPageRequest description: Paginação responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/effectiveResultContracts minimum: 1 description: Saldos do contrato totalElements: type: integer format: int64 description: Total de registros encontrados totalPages: type: integer format: int64 description: Total de paginas encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/queries/findContractBalanceUnlink: post: description: Consulta os saldos do contrato para desvinculo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – pageRequest properties: filter: type: object allOf: – #/definitions/filterEffectiveContract description: Filtros pageRequest: type: object allOf: – #/definitions/recPageRequest description: Paginação responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/contractEffectiveItems minimum: 1 description: Saldos do contrato totalElements: type: integer format: int64 description: Total de registros encontrados totalPages: type: integer format: int64 description: Total de paginas encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/queries/checkDeleteContract: post: description: Consulta se é possível excluir o contrato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contractId properties: contractId: type: string description: Id do contrato responses: 200: description: Ok schema: type: object required: – message properties: message: type: string allOf: – #/definitions/reasonDeleteContract description: Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta se é possível excluir o contrato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: contractId description: Id do contrato in: query required: true type: string responses: 200: description: Ok schema: type: object required: – message properties: message: type: string allOf: – #/definitions/reasonDeleteContract description: Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/queries/getTicketsWithContract: post: description: Consulta os tickets vinculados ao contrato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticketsContract properties: ticketsContract: type: array items: type: object allOf: – #/definitions/contractTicketDTO minimum: 1 description: Lista de tickets e produtores responses: 200: description: Ok schema: type: object required: – ticketsContract properties: ticketsContract: type: array items: type: object allOf: – #/definitions/ticketsContract minimum: 1 description: Lista de tickets e produtores com contratos disponíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/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 /contract/queries/exportE070emp: 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 /contract/queries/exportE070fil: 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 /contract/queries/exportE012fam: 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 /contract/queries/exportE113saf: 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 /contract/queries/exportE031smo: 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 /contract/queries/exportE031moe: 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 /contract/queries/exportE031imo: 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 /contract/queries/exportE075der: 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 /contract/queries/exportE001pes: 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 /contract/queries/exportE095pes: 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 /contract/queries/exportRuralEstate: 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 /contract/queries/exportE006pai: 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 /contract/queries/exportE007ufs: 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 /contract/queries/exportE008rai: 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 /contract/queries/exportFamilyGroup: 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 /contract/queries/exportContract: 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 /contract/queries/exportContractProduct: 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 /contract/queries/exportContractProductProducer: 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 /contract/queries/exportContractMovementHistory: 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 /contract/queries/exportApprovalSettings: 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 /contract/queries/exportApprovalSettingsGroup: 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 /contract/queries/exportApprovalContractRequest: 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 /contract/queries/exportContractEffectiveItems: 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 /contract/queries/exportIncrease: 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 /contract/queries/exportIncreaseProduct: 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 /contract/queries/exportIncreaseProductContract: 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 /contract/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 /contract/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/actions/linkUnlinkContract: post: description: Realiza Vinculo/Desvinculo de saldo no contrato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId – branchId – contractId – contractProductId – contractProducerId – contractOperation – items properties: companyId: type: string description: Id da empresa branchId: type: string description: Id da filial contractId: type: string description: Id do contrato contractProductId: type: string description: Id do produto do contrato contractProducerId: type: string description: Id do produtor do contrato contractOperation: type: string allOf: – #/definitions/contractOperation description: Operação do contrato items: type: array items: type: object allOf: – #/definitions/linkUnlinkContractItems minimum: 1 description: Itens da operação responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: sucesso message: type: string description: mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/actions/updateContractFixation: post: description: Atualiza contratos negociados na fixação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – effectiveId – contractId – fixationOperation properties: effectiveId: type: string description: Id do saldo efetivo contractId: type: string description: Id do contrato quantity: type: number format: double description: Quantidade negociada na fixação default: 0.0 fixationOperation: type: string allOf: – #/definitions/fixationOperation description: Finalização ou cancelamento responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: sucesso message: type: string description: mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/actions/cancelRequestApprovalContractTask: post: description: Solicitação do cancelamento da aprovação de contrato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contractId properties: contractId: type: string description: Id do contrato responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/actions/updateQuantityContract: post: description: Atualiza a quantidade do contrato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contractProductId – quantity properties: contractProductId: type: string description: Id do produto do contrato quantity: type: number format: double description: Quantidade responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: sucesso message: type: string description: mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/actions/linkFirstBalance: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contractId – contractProductId – contractProductProducerId – effectiveId properties: contractId: type: string description: Id do contrato contractProductId: type: string description: Id do produto do contrato contractProductProducerId: type: string description: Id do produtor do contrato effectiveId: type: string description: Id do saldo do produtor producerDeliveryId: type: string description: Id do produtor responsável pela entrega harvestId: type: string description: Id da safra do saldo quantity: type: number format: double description: Quantidade do movimento default: 0.0 responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: sucesso message: type: string description: mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/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 /contract/actions/importE070emp: 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 /contract/actions/importE070fil: 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 /contract/actions/importE012fam: 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 /contract/actions/importE113saf: 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 /contract/actions/importE031smo: 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 /contract/actions/importE031moe: 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 /contract/actions/importE031imo: 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 /contract/actions/importE075der: 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 /contract/actions/importE001pes: 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 /contract/actions/importE095pes: 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 /contract/actions/importRuralEstate: 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 /contract/actions/importE006pai: 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 /contract/actions/importE007ufs: 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 /contract/actions/importE008rai: 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 /contract/actions/importFamilyGroup: 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 /contract/actions/importContract: 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 /contract/actions/importContractProduct: 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 /contract/actions/importContractProductProducer: 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 /contract/actions/importContractMovementHistory: 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 /contract/actions/importApprovalSettings: 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 /contract/actions/importApprovalSettingsGroup: 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 /contract/actions/importApprovalContractRequest: 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 /contract/actions/importContractEffectiveItems: 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 /contract/actions/importIncrease: 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 /contract/actions/importIncreaseProduct: 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 /contract/actions/importIncreaseProductContract: 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 /contract/signals/requestApprovalContractTask: post: description: Solicitação de aprovação de contrato tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – contractId properties: contractId: type: string description: Id do contrato responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /contract/events/importE070empEvent: 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 /contract/events/exportE070empEvent: 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 /contract/events/importE070filEvent: 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 /contract/events/exportE070filEvent: 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 /contract/events/importE012famEvent: 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 /contract/events/exportE012famEvent: 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 /contract/events/importE113safEvent: 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 /contract/events/exportE113safEvent: 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 /contract/events/importE031smoEvent: 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 /contract/events/exportE031smoEvent: 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 /contract/events/importE031moeEvent: 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 /contract/events/exportE031moeEvent: 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 /contract/events/importE031imoEvent: 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 /contract/events/exportE031imoEvent: 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 /contract/events/importE075derEvent: 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 /contract/events/exportE075derEvent: 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 /contract/events/importE001pesEvent: 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 /contract/events/exportE001pesEvent: 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 /contract/events/importE095pesEvent: 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 /contract/events/exportE095pesEvent: 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 /contract/events/importRuralEstateEvent: 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 /contract/events/exportRuralEstateEvent: 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 /contract/events/importE006paiEvent: 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 /contract/events/exportE006paiEvent: 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 /contract/events/importE007ufsEvent: 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 /contract/events/exportE007ufsEvent: 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 /contract/events/importE008raiEvent: 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 /contract/events/exportE008raiEvent: 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 /contract/events/importFamilyGroupEvent: 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 /contract/events/exportFamilyGroupEvent: 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 /contract/events/importContractEvent: 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 /contract/events/exportContractEvent: 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 /contract/events/importContractProductEvent: 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 /contract/events/exportContractProductEvent: 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 /contract/events/importContractProductProducerEvent: 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 /contract/events/exportContractProductProducerEvent: 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 /contract/events/importContractMovementHistoryEvent: 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 /contract/events/exportContractMovementHistoryEvent: 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 /contract/events/importApprovalSettingsEvent: 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 /contract/events/exportApprovalSettingsEvent: 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 /contract/events/importApprovalSettingsGroupEvent: 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 /contract/events/exportApprovalSettingsGroupEvent: 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 /contract/events/importApprovalContractRequestEvent: 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 /contract/events/exportApprovalContractRequestEvent: 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 /contract/events/importContractEffectiveItemsEvent: 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 /contract/events/exportContractEffectiveItemsEvent: 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 /contract/events/importIncreaseEvent: 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 /contract/events/exportIncreaseEvent: 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 /contract/events/importIncreaseProductEvent: 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 /contract/events/exportIncreaseProductEvent: 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 /contract/events/importIncreaseProductContractEvent: 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 /contract/events/exportIncreaseProductContractEvent: 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 /contract/entities/e070emp: 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/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e070emp/{id}: 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/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e070fil: 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/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e070fil/{id}: 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/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e012fam: 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/e012fam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e012fam/{id}: 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/e012fam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e113saf: 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/e113saf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e113saf/{id}: 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/e113saf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e031smo: 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/e031smo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e031smo/{id}: 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/e031smo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e031moe: 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/e031moe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e031moe/{id}: 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/e031moe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e031imo: 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/e031imo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e031imo/{id}: 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/e031imo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e075der: 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/e075der 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e075der/{id}: 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/e075der 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e001pes: 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/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e001pes/{id}: 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/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e095pes: 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/e095pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e095pes/{id}: 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/e095pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/ruralEstate: 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/ruralEstate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/ruralEstate/{id}: 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/ruralEstate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e006pai: 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/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e006pai/{id}: 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/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e007ufs: 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/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e007ufs/{id}: 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/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e008rai: 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/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/e008rai/{id}: 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/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/familyGroup: 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/familyGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/familyGroup/{id}: 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/familyGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/contract: 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/contract responses: 200: description: The created resource schema: #/definitions/contract 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/contract responses: 200: description: The created resource schema: #/definitions/contract 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/contract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/contract/{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/editContract responses: 200: description: Ok schema: #/definitions/editContract 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/contract responses: 200: description: Ok schema: #/definitions/contract 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/contract 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 /contract/entities/contract/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contract responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/contractProduct: 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/contractProduct responses: 200: description: The created resource schema: #/definitions/contractProduct 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/contractProduct responses: 200: description: The created resource schema: #/definitions/contractProduct 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/contractProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/contractProduct/{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/editContractProduct responses: 200: description: Ok schema: #/definitions/editContractProduct 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/contractProduct responses: 200: description: Ok schema: #/definitions/contractProduct 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/contractProduct 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 /contract/entities/contract/{parentId}/contractProducts: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/contractProduct responses: 200: description: The created resources schema: type: array items: #/definitions/contractProduct 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/contractProduct responses: 200: description: The created resources schema: type: array items: #/definitions/contractProduct 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: parentId in: path required: true type: string – 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/contractProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/contract/{parentId}/contractProducts/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editContractProduct responses: 200: description: Ok schema: #/definitions/editContractProduct 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contractProduct responses: 200: description: Ok schema: #/definitions/contractProduct 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contractProduct 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/contractProduct/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contractProduct responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/contractProductProducer: 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/contractProductProducer responses: 200: description: The created resource schema: #/definitions/contractProductProducer 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/contractProductProducer responses: 200: description: The created resource schema: #/definitions/contractProductProducer 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/contractProductProducer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/contractProductProducer/{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/editContractProductProducer responses: 200: description: Ok schema: #/definitions/editContractProductProducer 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/contractProductProducer responses: 200: description: Ok schema: #/definitions/contractProductProducer 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/contractProductProducer 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 /contract/entities/contractProduct/{parentId}/contractProductProducers: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/contractProductProducer responses: 200: description: The created resources schema: type: array items: #/definitions/contractProductProducer 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/contractProductProducer responses: 200: description: The created resources schema: type: array items: #/definitions/contractProductProducer 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: parentId in: path required: true type: string – 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/contractProductProducer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/contractProduct/{parentId}/contractProductProducers/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editContractProductProducer responses: 200: description: Ok schema: #/definitions/editContractProductProducer 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contractProductProducer responses: 200: description: Ok schema: #/definitions/contractProductProducer 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contractProductProducer 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/contractProductProducer/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contractProductProducer responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/contractMovementHistory: 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/contractMovementHistory responses: 200: description: The created resource schema: #/definitions/contractMovementHistory 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/contractMovementHistory responses: 200: description: The created resource schema: #/definitions/contractMovementHistory 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/contractMovementHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/contractMovementHistory/{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/editContractMovementHistory responses: 200: description: Ok schema: #/definitions/editContractMovementHistory 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/contractMovementHistory responses: 200: description: Ok schema: #/definitions/contractMovementHistory 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/contractMovementHistory 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 /contract/entities/contractMovementHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contractMovementHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/approvalSettings: 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/approvalSettings 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/approvalSettings/{id}: 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/approvalSettings 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/approvalSettingsGroup: 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/approvalSettingsGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/approvalSettingsGroup/{id}: 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/approvalSettingsGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/approvalContractRequest: 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/approvalContractRequest responses: 200: description: The created resource schema: #/definitions/approvalContractRequest 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/approvalContractRequest responses: 200: description: The created resource schema: #/definitions/approvalContractRequest 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/approvalContractRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/approvalContractRequest/{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/editApprovalContractRequest responses: 200: description: Ok schema: #/definitions/editApprovalContractRequest 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/approvalContractRequest responses: 200: description: Ok schema: #/definitions/approvalContractRequest 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/approvalContractRequest 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 /contract/entities/contract/{parentId}/approvalContractRequests: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/approvalContractRequest responses: 200: description: The created resources schema: type: array items: #/definitions/approvalContractRequest 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/approvalContractRequest responses: 200: description: The created resources schema: type: array items: #/definitions/approvalContractRequest 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: parentId in: path required: true type: string – 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/approvalContractRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/contract/{parentId}/approvalContractRequests/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editApprovalContractRequest responses: 200: description: Ok schema: #/definitions/editApprovalContractRequest 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/approvalContractRequest responses: 200: description: Ok schema: #/definitions/approvalContractRequest 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/approvalContractRequest 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/approvalContractRequest/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/approvalContractRequest responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/contractEffectiveItems: 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/contractEffectiveItems responses: 200: description: The created resource schema: #/definitions/contractEffectiveItems 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/contractEffectiveItems responses: 200: description: The created resource schema: #/definitions/contractEffectiveItems 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/contractEffectiveItems 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/contractEffectiveItems/{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/editContractEffectiveItems responses: 200: description: Ok schema: #/definitions/editContractEffectiveItems 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/contractEffectiveItems responses: 200: description: Ok schema: #/definitions/contractEffectiveItems 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/contractEffectiveItems 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 /contract/entities/contractEffectiveItems/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contractEffectiveItems responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/increase: 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/increase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/increase/{id}: 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/increase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/increaseProduct: 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/increaseProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/increaseProduct/{id}: 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/increaseProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/increaseProductContract: 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/increaseProductContract responses: 200: description: The created resource schema: #/definitions/increaseProductContract 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/increaseProductContract responses: 200: description: The created resource schema: #/definitions/increaseProductContract 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/increaseProductContract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/increaseProductContract/{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/editIncreaseProductContract responses: 200: description: Ok schema: #/definitions/editIncreaseProductContract 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/increaseProductContract responses: 200: description: Ok schema: #/definitions/increaseProductContract 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/increaseProductContract 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 /contract/entities/contractProduct/{parentId}/increaseProducts: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/increaseProductContract responses: 200: description: The created resources schema: type: array items: #/definitions/increaseProductContract 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/increaseProductContract responses: 200: description: The created resources schema: type: array items: #/definitions/increaseProductContract 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: parentId in: path required: true type: string – 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/increaseProductContract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/contractProduct/{parentId}/increaseProducts/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editIncreaseProductContract responses: 200: description: Ok schema: #/definitions/editIncreaseProductContract 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/increaseProductContract responses: 200: description: Ok schema: #/definitions/increaseProductContract 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/increaseProductContract 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contract/entities/increaseProductContract/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/increaseProductContract responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: operationType: type: string enum: – ENTRY – EXIT – BLOCK – UNBLOCK – RESERVED – FIXATION – LINK – UNLINK description: Tipo de operação do saldo do produtor: * `ENTRY` – Entrada * `EXIT` – Saída * `BLOCK` – Bloqueio * `UNBLOCK` – Desbloqueio * `RESERVED` – Reservado * `FIXATION` – Fixação * `LINK` – Vinculo * `UNLINK` – Desvinculo reasonDeleteContract: type: string enum: – INACTIVATED_CONTRACT – CONTRACT_HAS_LINKED_MOVEMENTS – NO_IMPEDIMENT description: Verificação de exclusão de contrato: * `INACTIVATED_CONTRACT` – Realizado apenas a inativação do contrato * `CONTRACT_HAS_LINKED_MOVEMENTS` – Existem movimentos de vinculo no contrato * `NO_IMPEDIMENT` – Não existem impeditivos para exclusão statusEntity: type: string enum: – VA – VI description: Status da Entidade: * `VA` – Ativo * `VI` – Inativo contractSituation: type: string enum: – EDITING – WAITING_APPROVAL – ACTIVE description: Situação do Contrato: * `EDITING` – Em edição * `WAITING_APPROVAL` – Aguardando aprovação * `ACTIVE` – Ativo pricingType: type: string enum: – FIXED – VARIABLE description: Situação do Contrato: * `FIXED` – Fixo * `VARIABLE` – Variável pricingModality: type: string enum: – FIXED_PRICE – FIXED_QUOTATION description: Modalidade de precificação: * `FIXED_PRICE` – Preço Fixado * `FIXED_QUOTATION` – Cotação Fixada operation: type: string enum: – IMMEDIATE_BUY_ENTRY – ENTRY_IN_DEPOSIT – ENTRY_TO_BE_FIXED description: Operação: * `IMMEDIATE_BUY_ENTRY` – Entrada Compra Imediata * `ENTRY_IN_DEPOSIT` – Entrada Em Depósito * `ENTRY_TO_BE_FIXED` – Entrada a Fixar enumTipMoe: type: string enum: – VV – VD – VP – VE – VH description: Tipo da moeda: * `VV` – Valor * `VD` – Índice * `VP` – Percentual * `VE` – Especial * `VH` – Hora enumTipCot: type: string enum: – VD – VM description: Tipo da cotação: * `VD` – Diária * `VM` – Mensal contractOperation: type: string enum: – LINK – UNLINK – FIXATION – CANCEL_FIXATION description: Tipo da operação do contrato: * `LINK` – Vinculo * `UNLINK` – Desvinculo * `FIXATION` – Fixação * `CANCEL_FIXATION` – Cancelamento da Fixação approvalOrigin: type: string enum: – APPROVAL_WEIGHING – APPROVAL_TAX – APPROVAL_CONTRACT description: Origem da Aprovação – Solicitação: * `APPROVAL_WEIGHING` – Aprovação Alteração da Pesagem * `APPROVAL_TAX` – Aprovação Alteração Valor da Taxa * `APPROVAL_CONTRACT` – Aprovação Contrato statusChangeRequest: type: string enum: – APPROVED – REJECTED – IN_PROGRESS – CANCELED description: Status da solicitação BPM: * `APPROVED` – Aprovado * `REJECTED` – Reprovado * `IN_PROGRESS` – Em andamento * `CANCELED` – Cancelado typeIncrease: type: string enum: – P – V description: Tipo de Acréscimo: * `P` – Percentual * `V` – Valor typeApplication: type: string enum: – CLASSIFICATION – CONTRACT – FIXATION description: Tipo de Aplicação: * `CLASSIFICATION` – Classificação * `CONTRACT` – Contrato * `FIXATION` – Fixação fixationOperation: type: string enum: – FINISH_FIXATION – CANCEL_FIXATION description: Operação da fixação: * `FINISH_FIXATION` – Finalização * `CANCEL_FIXATION` – Cancelamento 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 healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim contractTicketDTO: description: DTO para contrato buscar os contratos para o ticket type: object required: – ticket – company – branch – product – harvest – operation – producers properties: ticket: type: integer format: int64 description: Ticket company: type: string description: Id da Empresa branch: type: string description: Id da Filial product: type: string description: Id do Produto harvest: type: string description: Id da Safra operation: type: string allOf: – #/definitions/operation description: Tipo de operação producers: type: array items: type: object allOf: – #/definitions/ticketProducers minimum: 1 description: Id dos produtores ticketsContract: description: DTO com Tickets e produtores type: object required: – ticketId – producersId properties: ticketId: type: integer format: int64 description: Id do ticket producersId: type: array items: type: string minimum: 1 description: Id dos produtores ticketProducers: description: DTO de produtores do ticket type: object required: – producerId – ruralEstateId properties: producerId: type: string description: Id do ticket ruralEstateId: type: string description: Id dos produtores linkUnlinkContractItems: description: Itens para vincular/desvincular os saldos no contrato type: object required: – effectiveId properties: effectiveId: type: string description: Id do saldo do produtor producerDeliveryId: type: string description: Id do produtor responsável pela entrega harvestId: type: string description: Id da safra do saldo quantity: type: number format: double description: Quantidade do movimento default: 0.0 filterEffectiveContract: description: Filtro para listagem de saldos efetivos para vinculo type: object required: – contract – contractProduct – contractProductProducer properties: contract: type: string description: Id do Contrato contractProduct: type: string description: Id do Produto do contrato contractProductProducer: type: string description: Id do Produtor do produto do contrato harvest: type: string description: Id da Safra familyGroup: type: string description: Id do grupo familiar startDate: type: string format: date description: Data de entrada inicio endDate: type: string format: date description: Data de entrada fim effectiveResultContracts: description: DTO de saldos do produtor para vinculo type: object required: – id – entryDate – producer – quantity – controlCode properties: id: type: string description: UUID entryDate: type: string format: date-time description: Data de entrada producer: type: object allOf: – #/definitions/e001pes description: Nome do Produtor quantity: type: number format: double description: Quantidade disponível para vincular currency: type: string description: Moeda controlCode: type: integer format: int64 description: Código do romaneio/ticket harvestId: type: string description: ID da safra nfeKey: type: string description: Chave da nota fiscal que efetivou o movimento nfeNumber: type: string description: Número de emissão da nota fiscal que efetivou o movimento nfeSeries: type: string description: Número da serie de emissão da nota fiscal que efetivou o movimento recPageRequest: description: Record para paginação e ordenação type: object properties: offset: type: integer format: int64 description: Offset da página default: 0 size: type: integer format: int64 description: Size da página default: 10 orderBy: type: object allOf: – #/definitions/recFieldsOrderBy description: Campos da ordenação dos registros a serem pesquisados undoingContractNewBalanceChangesInput: description: Record para envio dos dados na integração com agro/producer_net_value/undoingContractNewBalanceChanges type: object properties: effectiveId: type: string description: Id do saldo efetivo linkUnlinkContractBalanceInput: description: Record para envio dos dados na integração com agro/producer_net_value/linkUnlinkContractBalance type: object properties: effectiveId: type: string description: Id do saldo efetivo utilizado contractId: type: string description: Id do contrato contractProductId: type: string description: Id do produto do contrato contractProductProducerId: type: string description: Id do produtor do produto do contrato operation: type: string allOf: – #/definitions/operationType description: Operação quantity: type: number format: double description: Quantidade default: 0.0 linkUnlinkContractBalanceOutput: description: Record para retorno dos dados na integração com agro/producer_net_value/linkUnlinkContractBalance type: object properties: newEffectiveId: type: string description: Id do novo saldo efetivo getEffectiveAvailableInput: description: Record para envio dos dados para buscar os saldos disponíveis para contratos em agro/produtor_net_value/getEffectiveAvailable type: object properties: filter: type: object allOf: – #/definitions/filterEffective description: Filtros filterEffective: description: Filtro para listagem de saldos efetivos type: object properties: company: type: string description: Id da Empresa branch: type: string description: Id da Filial producer: type: string description: Id do Produtor product: type: string description: Id do Produto harvest: type: string description: Id da Safra familyGroup: type: string description: Id do grupo familiar startDate: type: string format: date description: Data de entrada inicio endDate: type: string format: date description: Data de entrada fim withContract: type: boolean description: saldos sem contratos vinculados default: true getEffectiveAvailableOutput: description: Record para retorno dos dados para buscar os saldos disponíveis para contratos em agro/produtor_net_value/getEffectiveAvailable type: object properties: contents: type: array items: type: object allOf: – #/definitions/effectiveResult description: Listagem de saldos disponíveis effectiveResult: description: Record para detalhar informações para contratos sobre o saldo do produtor type: object properties: id: type: string description: UUID producer: type: string description: Produtor entryDate: type: string format: date-time description: Data de entrada quantityAvailable: type: number format: double description: Quantidade disponível harvest: type: string description: Safra currency: type: string description: Moeda controlCode: type: integer format: int64 description: Código do romaneio/ticket nfeKey: type: string description: Chave da nota fiscal que efetivou o movimento nfeNumber: type: string description: Número de emissão da nota fiscal que efetivou o movimento nfeSeries: type: string description: Número da serie de emissão da nota fiscal que efetivou o movimento recFieldsOrderBy: description: Define o registro com os dados dos campos à serem ordenados type: object properties: field: type: string description: Nome do campo a ser ordenado default: lastModifiedDate order: type: integer format: int64 description: Tipo de ordenação do campo (ASC = 1 / DESC = -1) default: 1 businessDataDTO: description: Objeto para envio de solicitação de aprovação domain contrato no BPM type: object required: – company – branch – internal_contract_number – product – producer – rural_estate properties: company: type: string description: Empresa branch: type: string description: Filial internal_contract_number: type: integer format: int64 description: Número interno do contrato minimum: 0 contract_number: type: string description: Número do contrato quantity_consistency: type: boolean description: Consistência de quantidade default: false priority_for_receipt: type: boolean description: Contrato prioritário para recebimento default: false start_date: type: string description: Data de início do contrato end_date: type: string description: Data de término do contrato allow_write_off_by_group: type: boolean description: Permite baixa por grupo default: false product: type: string description: Produto do contrato harvest: type: string description: Safra quantity_contract: type: number format: double description: Quantidade contratada do produto default: 0.0 unit_price: type: string description: Preço Unitário default: 0.0 date_quotation: type: string description: Data da cotação pricing_type: type: string description: Tipo de precificação pricing_modality: type: string description: Modalidade de precificação currency: type: string description: Moeda producer: type: string description: Produtor rural_estate: type: string description: Imóvel Rural operation: type: string description: Tipo de operação de recebimento e070emp: description: Empresa type: object required: – codEmp – nomEmp – sigEmp properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código da empresa nomEmp: type: string maxLength: 100 description: Nome da empresa sigEmp: type: string maxLength: 100 description: Nome fantasia / Sigla da empresa extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e070fil: description: Filial type: object required: – e070emp – codFil – nomFil – sigFil properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa codFil: type: integer format: int64 description: Código da filial nomFil: type: string maxLength: 100 description: Nome da filial sigFil: type: string maxLength: 100 description: Nome fantasia da filial numCgc: type: string maxLength: 18 description: CNPJ cidFil: type: string maxLength: 60 description: Cidade numFon: type: string maxLength: 20 description: Numero Telefone extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e012fam: description: Família type: object required: – e070emp – codFam – desFam – sitFam properties: id: type: string format: uuid description: Id e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa codFam: type: string maxLength: 6 description: Código desFam: type: string maxLength: 50 description: Descrição sitFam: type: string allOf: – #/definitions/statusEntity description: Status extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e113saf: description: Safra type: object required: – e070emp – codSaf – desSaf – sitSaf properties: id: type: string format: uuid description: Safra UUID e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa codSaf: type: string maxLength: 10 description: Código da safra desSaf: type: string maxLength: 50 description: Descrição da safra cptIni: type: string format: date description: Competência inicial cptFim: type: string format: date description: Competência final sitSaf: type: string allOf: – #/definitions/statusEntity description: Situação da safra extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e031smo: description: Série de cotação da moeda type: object required: – codSmo properties: id: type: string format: uuid description: Id da entidade codSmo: type: integer format: int64 description: Código minimum: 0 maximum: 999999999 desSmo: type: string maxLength: 250 description: Descrição excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e031moe: description: Moedas type: object required: – codMoe – desMoe – sigMoe – tipMoe – tipCot properties: id: type: string format: uuid description: Id da entidade codMoe: type: string maxLength: 3 description: Código da moeda desMoe: type: string maxLength: 30 description: Descrição da moeda sigMoe: type: string maxLength: 5 description: Sigla da moeda tipMoe: type: string allOf: – #/definitions/enumTipMoe description: Tipo da moeda tipCot: type: string allOf: – #/definitions/enumTipCot description: Tipo de cotação diaBas: type: integer format: int64 description: Dia base de cotação minimum: 0 maximum: 31 qtdInt: type: integer format: int64 description: Quantidade de inteiros minimum: 0 maximum: 13 qtdDec: type: integer format: int64 description: Quantidade de decimais minimum: 0 maximum: 10 separadorMilhar: type: string maxLength: 1 description: Separador de milhar separadorDecimal: type: string maxLength: 1 description: Separador de decimal codBac: type: integer format: int64 description: Código BACEN minimum: 0 maximum: 999 e031smoIdeSmo: type: object allOf: – #/definitions/e031smo description: Série de cotação da moeda excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e031imo: description: Cotação da moeda type: object required: – datMoe – e031moe properties: id: type: string format: uuid description: Id datMoe: type: string format: date description: Data da cotação vlrCot: type: string description: Valor da cotação minimum: 0.00 maximum: 999999999.9999999999 vlrPre: type: string description: Valor da preço cotação minimum: 0.00 maximum: 999999999.9999999999 e031moe: type: object allOf: – #/definitions/e031moe description: Moeda da cotação excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e075der: description: Produto type: object required: – e070emp – e012fam – codDer – desDer – sitDer properties: id: type: string format: uuid description: Id e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa e012fam: type: object allOf: – #/definitions/e012fam description: Código da família codDer: type: string maxLength: 23 description: Código da derivação desDer: type: string maxLength: 120 description: Descrição da derivação sitDer: type: string allOf: – #/definitions/statusEntity description: Situação da derivação extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e001pes: description: Pessoa type: object required: – nomPes – sitPes properties: id: type: string format: uuid description: Id Pessoa nomPes: type: string maxLength: 100 description: Nome cnpCpf: type: string maxLength: 18 description: CNPJ/CPF sitPes: type: string allOf: – #/definitions/statusEntity description: Status e095pes: type: object allOf: – #/definitions/e095pes description: Produtor familyGroups: type: array items: type: object allOf: – #/definitions/familyGroup description: Grupo Familiar extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e095pes: description: Fornecedor type: object required: – sitFor properties: id: type: string format: uuid description: Id Pessoa e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa sitFor: type: string allOf: – #/definitions/statusEntity description: Status extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: ruralEstate: description: Imóveis Rurais type: object required: – company – branch – name – cep – address – status properties: id: type: string format: uuid description: Id sequential: type: integer format: int64 description: Sequencial company: type: object allOf: – #/definitions/e070emp description: Empresa branch: type: object allOf: – #/definitions/e070fil description: Filial code: type: string maxLength: 13 description: Código do Imóvel Rural name: type: string description: Nome do Imóvel ie: type: string maxLength: 25 description: Inscrição Estadual cep: type: string maxLength: 8 description: CEP address: type: string description: Endereço number: type: integer format: int64 description: Número complement: type: string description: Complemento district: type: string description: Bairro country: type: object allOf: – #/definitions/e006pai description: País state: type: object allOf: – #/definitions/e007ufs description: Estado city: type: object allOf: – #/definitions/e008rai description: Cidade latitude: type: string description: Latitude longitude: type: string description: Longitude status: type: string allOf: – #/definitions/statusEntity description: Situação do Imóvel producers: type: array items: type: object allOf: – #/definitions/e001pes description: Lista de Produtores producersQuantity: type: integer format: int64 description: Quantidade de Produtores default: 0 extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e006pai: description: Tabelas – Países type: object required: – codPai – nomPai – e031moe properties: id: type: string format: uuid description: Id da entidade codPai: type: string maxLength: 4 description: Código nomPai: type: string maxLength: 150 description: Nome e031moe: type: object allOf: – #/definitions/e031moe description: Id da moeda excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e007ufs: description: Tabelas – Estados type: object required: – sigUfs – nomUfs – e006pai properties: id: type: string format: uuid description: Id da entidade sigUfs: type: string maxLength: 2 description: Sigla nomUfs: type: string maxLength: 20 description: Nome e006pai: type: object allOf: – #/definitions/e006pai description: País excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e008rai: description: Tabelas – Cidades para RAIS – SIG type: object required: – codRai – nomCid – e007ufs properties: id: type: string format: uuid description: Id da entidade codRai: type: integer format: int64 description: Código Cidade minimum: 0 maximum: 9999999 nomCid: type: string maxLength: 60 description: Nome Cidade e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado codIbg: type: integer format: int64 description: Código IBGE do município minimum: 0 maximum: 9999999 excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: familyGroup: description: Grupo Famíliar type: object required: – name – status properties: id: type: string format: uuid description: Id code: type: integer format: int64 description: código do grupo famíliar name: type: string description: Nome do grupo famíliar status: type: string allOf: – #/definitions/statusEntity description: Situação do grupo famíliar producers: type: array items: type: object allOf: – #/definitions/e001pes description: Lista de Produtores producersQuantity: type: integer format: int64 description: Quantidade de Produtores default: 0 extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: contract: description: Contrato type: object required: – company – branch – situation properties: id: type: string format: uuid description: Id da entidade company: type: object allOf: – #/definitions/e070emp description: Empresa branch: type: object allOf: – #/definitions/e070fil description: Filial internalContractNumber: type: integer format: int64 description: Número interno do contrato contractNumber: type: string maxLength: 255 description: Número do contrato quantityConsistency: type: boolean description: Consistência de quantidade default: false priorityForReceipt: type: boolean description: Contrato prioritário para recebimento default: false startDate: type: string format: date description: Data de início do contrato endDate: type: string format: date description: Data de término do contrato allowWriteOffByGroup: type: boolean description: Permite baixa por grupo default: false situation: type: string allOf: – #/definitions/contractSituation description: Indicador da situação do contrato status: type: string allOf: – #/definitions/statusEntity description: Indicador do status do contrato contractProducts: type: array items: type: object allOf: – #/definitions/contractProduct description: Lista de produtos do contrato approvalContractRequests: type: array items: type: object allOf: – #/definitions/approvalContractRequest description: Lista de solicitações de aprovação de contrato createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editContract: type: object required: – id allOf: – #/definitions/contract contractProduct: description: Produto do contrato type: object properties: id: type: string format: uuid description: Id da entidade contract: type: object allOf: – #/definitions/contract description: Contrato productSequence: type: integer format: int64 description: Sequencia product: type: object allOf: – #/definitions/e075der description: Produto harvest: type: object allOf: – #/definitions/e113saf description: Safra quantityContract: type: number format: double description: Quantidade contratada do produto default: 0.0 quantityEffectived: type: number format: double description: Quantidade vinculada do produto default: 0.0 quantityRemaining: type: number format: double description: Quantidade restante do produto default: 0.0 quantityCanceled: type: number format: double description: Quantidade default: 0.0 quantityContracted: type: number format: double description: Quantidade contratada default: 0.0 quantityFixed: type: number format: double description: Quantidade fixada default: 0.0 unitPrice: type: string description: Preço Unitário dateQuotation: type: string format: date description: Data da cotação pricingType: type: string allOf: – #/definitions/pricingType description: Tipo de precificação pricingModality: type: string allOf: – #/definitions/pricingModality description: Modalidade de precificação currency: type: object allOf: – #/definitions/e031moe description: Moeda contractProductProducers: type: array items: type: object allOf: – #/definitions/contractProductProducer description: Produtores vinculado ao produto increaseProducts: type: array items: type: object allOf: – #/definitions/increaseProductContract description: Acréscimos vinculados ao produto quotation: type: object allOf: – #/definitions/e031imo description: Cotação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editContractProduct: type: object required: – id allOf: – #/definitions/contractProduct contractProductProducer: description: Produtor vinculado ao produto do contrato type: object properties: id: type: string format: uuid description: Id da entidade contractProduct: type: object allOf: – #/definitions/contractProduct description: Produto do contrato producer: type: object allOf: – #/definitions/e095pes description: Produtor ruralEstate: type: object allOf: – #/definitions/ruralEstate description: Imóvel rural operation: type: string allOf: – #/definitions/operation description: Operação da originação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editContractProductProducer: type: object required: – id allOf: – #/definitions/contractProductProducer contractMovementHistory: description: Histórico de movimentos de contratos type: object required: – company – contractProduct – contract – historySequence – contractProductProducer – effective – contractOperation properties: id: type: string format: uuid description: Id da entidade company: type: object allOf: – #/definitions/e070emp description: Empresa branch: type: object allOf: – #/definitions/e070fil description: Filial contractProduct: type: object allOf: – #/definitions/contractProduct description: Produto do contrato contract: type: object allOf: – #/definitions/contract description: Contrato historySequence: type: integer format: int64 description: Sequencia contractProductProducer: type: object allOf: – #/definitions/contractProductProducer description: Produtor do produto do contrato producerDelivery: type: object allOf: – #/definitions/e095pes description: Produtor responsável pela entrega effective: type: string description: Saldo do produtor effectiveOriginal: type: string description: Saldo do produtor original harvestId: type: string description: Id da safra quantity: type: number format: double description: Quantidade do movimento default: 0.0 contractOperation: type: string allOf: – #/definitions/contractOperation description: Operação do contrato createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editContractMovementHistory: type: object required: – id allOf: – #/definitions/contractMovementHistory approvalSettings: description: Configuração da aprovação e templates por grupo de usuário da plataforma e por empresa/filial type: object required: – company – branches – approvalOrigin – processConfig – groups properties: id: type: string format: uuid description: Id da entidade company: type: object allOf: – #/definitions/e070emp description: Empresa branches: type: array items: type: object allOf: – #/definitions/e070fil minimum: 1 description: Filiais approvalOrigin: type: string allOf: – #/definitions/approvalOrigin description: Origem da Aprovação processConfig: type: integer format: int64 description: Template BPM da plataforma groups: type: array items: type: object allOf: – #/definitions/approvalSettingsGroup minimum: 1 description: Approval Settings Groups extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: approvalSettingsGroup: description: Itens de Grupo de usuário da plataforma relacionados a uma configuração de aprovação type: object required: – groupId properties: id: type: string format: uuid description: Id da entidade approvalSettings: type: object allOf: – #/definitions/approvalSettings description: Setting groupId: type: string format: uuid description: Grupo de Usuários da plataforma extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: approvalContractRequest: description: Solicitação de aprovação do contrato type: object required: – status – payloadContent properties: id: type: string format: uuid description: Id da entidade contract: type: object allOf: – #/definitions/contract description: Contrato processId: type: integer format: int64 description: Id do processo BPM processInstanceId: type: integer format: int64 description: Id da instancia do processo BPM status: type: string allOf: – #/definitions/statusChangeRequest description: Status payloadContent: type: string description: Payload recebido para criar a solicitação payloadBpmRequest: type: string description: Payload BPM do envio payloadBpmResponse: type: string description: Payload BPM da resposta createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editApprovalContractRequest: type: object required: – id allOf: – #/definitions/approvalContractRequest contractEffectiveItems: description: Itens vinculados ao contrato type: object required: – contract – contractProduct – contractProductProducer – effective properties: id: type: string format: uuid description: Id da entidade contract: type: object allOf: – #/definitions/contract description: Contrato contractProduct: type: object allOf: – #/definitions/contractProduct description: Produto do contrato contractProductProducer: type: object allOf: – #/definitions/contractProductProducer description: Produtor do produto do contrato effective: type: string description: Saldo do produtor harvestId: type: string description: Id da safra quantityLink: type: number format: double description: Quantidade do saldo vinculada default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editContractEffectiveItems: type: object required: – id allOf: – #/definitions/contractEffectiveItems increase: description: Acréscimo Financeiro type: object required: – company – codInc – desInc – sitInc – application properties: id: type: string format: uuid description: Id company: type: object allOf: – #/definitions/e070emp description: Código da empresa codInc: type: string description: Código do acréscimo desInc: type: string description: Descrição do acréscimo sitInc: type: string allOf: – #/definitions/statusEntity description: Situação do acréscimo application: type: string allOf: – #/definitions/typeApplication description: Tipo de aplicação products: type: array items: type: object allOf: – #/definitions/increaseProduct description: Produtos Vinculados extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: increaseProduct: description: Produtos Vinculados type: object required: – company – product – typeIncrease – valInc – grpItm – sitPro properties: id: type: string format: uuid description: Id increase: type: object allOf: – #/definitions/increase description: Acréscimo financeiro company: type: object allOf: – #/definitions/e070emp description: Código da empresa product: type: object allOf: – #/definitions/e075der description: Produto typeIncrease: type: string allOf: – #/definitions/typeIncrease description: Tipo de acréscimo valInc: type: number format: double description: Valor do acréscimo grpItm: type: boolean description: Agrupar itens sitPro: type: string allOf: – #/definitions/statusEntity description: Situação do vinculo extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: increaseProductContract: description: Vinculo de contrato com o acréscimo type: object properties: id: type: string format: uuid description: Id increaseProduct: type: object allOf: – #/definitions/increaseProduct description: Acréscimo financeiro contractProduct: type: object allOf: – #/definitions/contractProduct description: Contrato typeIncrease: type: string allOf: – #/definitions/typeIncrease description: Tipo de acréscimo valInc: type: number format: double description: Valor do acréscimo grpItm: type: boolean description: Agrupar itens sitPro: type: string allOf: – #/definitions/statusEntity description: Situação do vinculo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editIncreaseProductContract: type: object required: – id allOf: – #/definitions/increaseProductContract 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 checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status 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