2.0info: 1.8.0 producer_net_value description: Saldo do Produtor Rural x-senior-domain: agro x-senior-domain-path: agro x-senior-service-path: producer_net_value 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: /producer_net_value/queries/simulateTransferQuantityOnAvailableBalance: post: description: Simula a aplicação de uma quantidade a transferir, de acordo com os saldos disponíveis encontrados no filtro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – quantityToTransfer properties: filter: type: object allOf: – #/definitions/effectiveListForProducerTransferFilter description: Filtro para a consulta de effectives sort: type: object allOf: – #/definitions/orderByRequest description: Ordenação quantityToTransfer: type: number format: double description: Quantidade a transferir para simulação responses: 200: description: Ok schema: type: object required: – result – quantityToTransfer properties: result: type: array items: type: object allOf: – #/definitions/effectiveSimulatedWithTransferQuantity minimum: 1 description: Lista dos saldos simulados quantityToTransfer: type: number format: double description: Quantidade a transferir para simulação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/queries/getEffectiveListForProducerTransfer: post: description: Consulta para o processo de transferência de saldos entre produtores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/effectiveListForProducerTransferFilter description: Filtros para a consulta dos effectives pageRequest: type: object allOf: – #/definitions/recPageRequest description: Paginação sort: type: object allOf: – #/definitions/orderByRequest description: Ordenação responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: object allOf: – #/definitions/effectiveListForProducerTransferOutput description: Output contendo todas as informações necessárias para o processo de transferência totalElements: type: integer format: int64 description: Total de registros totalPages: type: integer format: int64 description: Total de paginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/queries/getNetValueSummary: post: description: Obtém o resumo do saldo do produtor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/searchFilters description: Parâmetros de filtragem responses: 200: description: Ok schema: type: object required: – balance properties: balance: type: array items: type: object allOf: – #/definitions/netValueSummary minimum: 1 description: Resumo do saldo do produtor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/queries/getNetValueMovementDetails: post: description: getListBalanceEntries tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/searchFilters description: Parâmetros de filtragem responses: 200: description: Ok schema: type: object required: – movementBalance properties: movementBalance: type: array items: type: object allOf: – #/definitions/netValueMovementDetails minimum: 1 description: Detalhes das movimentações do saldo do produtor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/queries/listEffectiveMovements: post: description: listEffectiveMovements tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/searchFilters description: Parâmetros de filtragem pageRequest: type: object allOf: – #/definitions/recPageRequest description: Paginação sort: type: object allOf: – #/definitions/orderByRequest description: Ordenação responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/movement minimum: 1 description: Lista de Movimentos totalElements: type: integer format: int64 description: Total de registros totalPages: type: integer format: int64 description: Total de paginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/queries/getDefinitionE099usuAgrSal: post: description: Retorna a definição do usuário : Agronegócio Saldo do Produtor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codUsu – e070empId properties: codUsu: type: string description: Identificador do usuario e070empId: type: string description: Identificador da empresa responses: 200: description: Ok schema: type: object required: – e099usuAgrSal properties: e099usuAgrSal: type: object allOf: – #/definitions/e099usuAgrSal description: Definição do usuário de: Agronegócio Saldo do Produtor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a definição do usuário : Agronegócio Saldo do Produtor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codUsu description: Identificador do usuario in: query required: true type: string – name: e070empId description: Identificador da empresa in: query required: true type: string responses: 200: description: Ok schema: type: object required: – e099usuAgrSal properties: e099usuAgrSal: type: object allOf: – #/definitions/e099usuAgrSal description: Definição do usuário de: Agronegócio Saldo do Produtor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/queries/getProducerRegistrationData: post: description: Retorna produtos movimentados pelo produtor e sua carga mais antiga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – producerId properties: producerId: type: string description: Id do Produtor responses: 200: description: Ok schema: type: object required: – products – oldestLoad properties: products: type: string description: Produtos oldestLoad: type: string description: Carga mais Antiga 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna produtos movimentados pelo produtor e sua carga mais antiga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: producerId description: Id do Produtor in: query required: true type: string responses: 200: description: Ok schema: type: object required: – products – oldestLoad properties: products: type: string description: Produtos oldestLoad: type: string description: Carga mais Antiga 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/queries/getEffectiveSummaryByType: post: description: Retorna o saldo efetivo por tipo de filtro (Produtor, Safra, Imóvel Rural, Contrato) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId – branchId – producerId – filterType properties: companyId: type: string description: Id da Empresa branchId: type: string description: Id da Filial producerId: type: string description: Id do Produtor productId: type: string description: Id do produto filterId: type: string description: Id do filtro agrupador filterType: type: string allOf: – #/definitions/balanceType description: Tipo de agrupador entryType: type: array items: type: string allOf: – #/definitions/operation description: Origem da operação responses: 200: description: Ok schema: type: object required: – balance properties: balance: type: array items: type: object allOf: – #/definitions/groupedEffectiveTotalizers minimum: 1 description: Saldo efetivo por tipo de filtro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviços checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviços checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/queries/getListBlocks: post: description: Lista os bloqueios tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: object allOf: – #/definitions/filterBlocks description: Filtros size: type: integer format: int64 description: Quantidade de itens por página default: 10 offset: type: integer format: int64 description: Paginação default: 0 orderBy: type: string description: Ordenação default: lastModifiedDate asc responses: 200: description: Ok schema: type: object required: – contents – totalElements properties: contents: type: array items: type: object allOf: – #/definitions/blockWithProducer minimum: 1 description: Listagem dos bloqueios totalElements: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/queries/getEffectiveAvailable: post: description: Lista os saldos disponíveis para contratos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: object allOf: – #/definitions/filterEffective description: Filtros responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/effectiveResult minimum: 1 description: Listagem de saldos disponíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/queries/getBlockBalances: post: description: Primitiva responsavel por trazer os saldos bloqueados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/filterBalanceBlocks description: Filtros size: type: integer format: int64 description: Quantidade de itens por página default: 10 offset: type: integer format: int64 description: Paginação default: 0 responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/effective minimum: 1 description: Lista de bloqueios totalElements: type: integer format: int64 description: Total de registros totalPages: type: integer format: int64 description: Total de paginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/queries/getNfeNumber: post: description: Primitiva responsavel por trazer as notas fiscais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/filterNfeNumber description: Filtros size: type: integer format: int64 description: Quantidade de itens por página default: 10 offset: type: integer format: int64 description: Paginação default: 0 orderBy: type: string description: Ordenação default: lastModifiedDate asc responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/movement minimum: 1 description: Lista de bloqueios totalElements: type: integer format: int64 description: Total de registros totalPages: type: integer format: int64 description: Total de paginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/queries/getEffectiveByExternalId: post: description: Endpoint para retornar o saldo efetivo por id externo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – externalId properties: externalId: type: string description: Id externo responses: 200: description: Ok schema: type: object required: – effective properties: effective: type: array items: type: object allOf: – #/definitions/effectiveResult minimum: 1 description: Saldo efetivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Endpoint para retornar o saldo efetivo por id externo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: externalId description: Id externo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – effective properties: effective: type: array items: type: object allOf: – #/definitions/effectiveResult minimum: 1 description: Saldo efetivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/queries/getListE001pesWithQuantityAvailable: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId properties: cnpCpf: type: string description: filtro de cpf nomPes: type: string description: filtro de nome companyId: type: string description: empresa id branchId: type: string description: filial id size: type: integer format: int64 description: Quantidade de itens por página default: 10 offset: type: integer format: int64 description: Paginação default: 0 orderby: type: string description: Ordenação responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/e001pes minimum: 1 description: Lista de produtores totalElements: type: integer format: int64 description: Total de registros totalPages: type: integer format: int64 description: Total de paginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cnpCpf description: filtro de cpf in: query type: string – name: nomPes description: filtro de nome in: query type: string – name: companyId description: empresa id in: query required: true type: string – name: branchId description: filial id in: query type: string – name: size description: Quantidade de itens por página in: query type: integer format: int64 – name: offset description: Paginação in: query type: integer format: int64 – name: orderby description: Ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/e001pes minimum: 1 description: Lista de produtores totalElements: type: integer format: int64 description: Total de registros totalPages: type: integer format: int64 description: Total de paginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/queries/getEffectiveAvailableWithTotalizers: post: description: Lista os saldos disponíveis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: object allOf: – #/definitions/filterEffective description: Filtros responses: 200: description: Ok schema: type: object required: – totalizers – contents properties: totalizers: type: object allOf: – #/definitions/groupedEffectiveTotalizers description: contents: type: array items: type: object allOf: – #/definitions/effectiveResult minimum: 1 description: Listagem de saldos disponíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/queries/exportProvisional: 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 /producer_net_value/queries/exportEffective: 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 /producer_net_value/queries/exportQuantities: 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 /producer_net_value/queries/exportContractReference: 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 /producer_net_value/queries/exportInvoiceEntry: 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 /producer_net_value/queries/exportMovement: 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 /producer_net_value/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 /producer_net_value/queries/exportE021mot: 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 /producer_net_value/queries/exportE099usuAgrSal: 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 /producer_net_value/queries/exportBlock: 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 /producer_net_value/queries/exportBlockMovement: 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 /producer_net_value/queries/exportProducerProtection: 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 /producer_net_value/queries/exportHolder: 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 /producer_net_value/queries/exportVariety: 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 /producer_net_value/queries/exportProductVariety: 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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/queries/exportEffectiveIncrease: 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 /producer_net_value/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 /producer_net_value/actions/printProducerExtractReport: post: description: Imprimir relatório de extrato do produtor tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – e070empId – e001pesId properties: e070empId: type: string description: Id da empresa e070filId: type: string description: Id da filial e001pesId: type: string description: Id do produtor e075derId: type: string description: Id do produto startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final ticketNumber: type: integer format: int64 description: Número do ticket ruralEstateId: type: string description: Id do imóvel rural e113safId: type: string description: Id da safra responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/actions/createProvisionalBalance: post: description: Insere o saldo do produtor provisório na tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – company – branch – entryDate – producer – product – quantityEntry – harvest – controlCode properties: company: type: string description: Empresa branch: type: string description: Filial entryDate: type: string format: date-time description: Data Entrada producer: type: string description: Producer product: type: string description: Produto quantityEntry: type: number format: double description: Quantidade Entrada minimum: 0.0 harvest: type: string description: Safra currency: type: string description: Moeda controlCode: type: integer format: int64 description: Código do romaneio/ticket ruralEstate: type: string description: Imovel Rural – Origem da mercadoria externalId: type: string description: Id externo responses: 200: description: Ok schema: type: object required: – protocol properties: protocol: type: string description: Protocolo externalId: type: string description: Id externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/actions/updateProvisionalBalance: post: description: Atualiza o saldo provisório do produtor tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – company – branch – entryDate – producer – product – quantityEntry – harvest – controlCode properties: externalId: type: string description: buscar o registro pelo externalId preferencialmente protocol: type: string description: buscar o registro pelo protocolo company: type: string description: Empresa branch: type: string description: Filial entryDate: type: string format: date-time description: Data Entrada producer: type: string description: Producer product: type: string description: Produto quantityEntry: type: number format: double description: Quantidade Entrada minimum: 0.0 harvest: type: string description: Safra currency: type: string description: Moeda controlCode: type: integer format: int64 description: Código do romaneio/ticket ruralEstate: type: string description: Imovel Rural – Origem da mercadoria responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso ao atualizar o registro message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/actions/removeProvisionalBalance: post: description: Deleta um saldo provisorio do produtor tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: externalId: type: string description: buscar o registro pelo externalId preferencialmente protocol: type: string description: buscar o registro pelo protocolo responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso ao atualizar o registro message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/actions/removeProducerBalance: post: description: Remover um saldo do produtor tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: externalId: type: string description: buscar o registro pelo externalId preferencialmente protocol: type: string description: buscar o registro pelo protocolo responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso ao atualizar o registro message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/actions/transferProducerBalance: post: description: Responsável pela transferência do saldo do produtor tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – effectiveOutgoingBalances – effectiveIncomingBalances properties: effectiveOutgoingBalances: type: array items: type: object allOf: – #/definitions/effectiveOutgoingBalance minimum: 1 description: Dados dos saldos de origem à serem transferidos effectiveIncomingBalances: type: array items: type: object allOf: – #/definitions/effectiveIncomingBalance minimum: 1 description: Dados dos saldos de destino à serem criados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/actions/createEffectiveBalance: post: description: Cria o movimento de saldo efetivo pendente para o produtor tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId – branchId – entryDate – producerId – productId – harvestId – controlCode – origin – operation – invoiceDetail properties: companyId: type: string description: Empresa branchId: type: string description: Filial entryDate: type: string format: date-time description: Data Entrada producerId: type: string description: Producer productId: type: string description: Produto harvestId: type: string description: Safra controlCode: type: integer format: int64 description: Código do romaneio/ticket ruralEstateId: type: string description: Imóvel Rural – Origem da mercadoria externalId: type: string description: Id externo provisionalExternalId: type: string description: Id externo informado para o saldo provisório origin: type: string allOf: – #/definitions/originType description: Origem do movimento operation: type: string allOf: – #/definitions/operationType description: Tipo de origem da operação classificationId: type: string description: Classificação aplicada na entrada invoiceDetail: type: object allOf: – #/definitions/invoiceDetailRecord description: Detalhe do movimento de saldo efetivo efetuado pela NF contract: type: object allOf: – #/definitions/contractRecord description: Contrato vinculado ao saldo do produtor royalty: type: object allOf: – #/definitions/royaltyRecord description: Credito de royalty do produtor responses: 200: description: Ok schema: type: object required: – protocol properties: protocol: type: string description: Protocolo externalId: type: string description: Id externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/actions/registerOperationBlock: post: description: Registra uma operação de bloqueio tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – company – description – producer – product – reason – quantityRequested – status – blockEntry properties: company: type: string description: Código da empresa description: type: string description: Descrição da operação producer: type: string description: Produtor product: type: string description: Produto reason: type: string description: Motivo da operação quantityRequested: type: number format: double description: Quantidade da operação de bloqueio solicitada minimum: 0.0 observation: type: string description: Observação status: type: string allOf: – #/definitions/statusEntity description: Status do registro blockEntry: type: boolean description: Bloqueia saldo na entrada responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso ao registrar a operação de bloqueio message: type: string description: Mensagem de retorno id: type: string description: Id do registro salvo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/actions/blockOperationBalance: post: description: blockOperationBalance tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operation – blockId – blockItens properties: operation: type: string allOf: – #/definitions/operationType description: Operação de bloqueio blockId: type: string description: Id do bloqueio blockItens: type: array items: type: object allOf: – #/definitions/blockBalanceItens minimum: 1 description: Itens do bloqueio responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso ao registrar a operação de bloqueio message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/actions/protectProducer: post: description: Protege o saldo produtor de alterações tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – producer – status – dateProtect properties: producer: type: string description: Identificador do Produtor status: type: string allOf: – #/definitions/protectType description: Status dateProtect: type: string format: date-time description: Data e hora de proteção responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/actions/scheduleProducerProtection: post: description: Timer para proteção do saldo do produtor tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – releaseTime properties: releaseTime: type: integer format: int64 description: Tempo de liberação – Milisegundos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/actions/producerBalanceWriteoff: post: description: Endpoint responsável pela baixa do saldo do produtor tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – effectiveId – company – branch – movementDate – quantity – externalId properties: effectiveId: type: string description: Id do saldo efetivo company: type: string description: Id da empresa branch: type: string description: Id da filial movementDate: type: string format: date-time description: Data e hora de saída quantity: type: number format: double description: Quantidade fixada minimum: 0.0 nfeKey: type: string maxLength: 44 description: Chave da nota fiscal que efetivou o movimento nfeNumber: type: string maxLength: 9 description: Número de emissão da nota fiscal que efetivou o movimento nfeSeries: type: string maxLength: 30 description: Número da serie de emissão da nota fiscal que efetivou o movimento nfeDate: type: string format: date-time description: Data/hora em que ocorreu a emissão da nota fiscal que efetivou o movimento externalId: type: string description: Id externo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/actions/linkUnlinkContractBalance: post: description: Endpoint para criar um novo saldo baseado no contrato vinculado/desvinculado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – effectiveId – contractId – contractProductId – contractProductProducerId – operation 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 responses: 200: description: Ok schema: type: object required: – newEffectiveId properties: newEffectiveId: type: string description: Id do novo saldo efetivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/actions/reserveOrReleaseEffectiveBalance: post: description: Endpoint para reservar e liberar reserva do saldo efetivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – chargesToBeReserved – operation properties: chargesToBeReserved: type: array items: type: object allOf: – #/definitions/chargesToBeReserved minimum: 1 description: Cargas a serem reservadas operation: type: string allOf: – #/definitions/operationType description: Tipo de operação responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/actions/importProvisional: 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 /producer_net_value/actions/importEffective: 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 /producer_net_value/actions/importQuantities: 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 /producer_net_value/actions/importContractReference: 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 /producer_net_value/actions/importInvoiceEntry: 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 /producer_net_value/actions/importMovement: 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 /producer_net_value/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 /producer_net_value/actions/importE021mot: 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 /producer_net_value/actions/importE099usuAgrSal: 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 /producer_net_value/actions/importBlock: 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 /producer_net_value/actions/importBlockMovement: 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 /producer_net_value/actions/importProducerProtection: 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 /producer_net_value/actions/importHolder: 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 /producer_net_value/actions/importVariety: 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 /producer_net_value/actions/importProductVariety: 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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/actions/importEffectiveIncrease: 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 /producer_net_value/signals/effectiveBalanceConfirmation: post: description: Evento de confirmação de saldo efetivo tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – externalId properties: eventControlItemId: type: string description: Id do item controle de eventos externalId: type: string description: Id externo vinculado ao saldo do produtor responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /producer_net_value/signals/refreshEffectiveSummary: post: description: Atualiza os indicadores de saldo efetivo do produtor tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – effectiveId properties: effectiveId: type: string description: ID do saldo efetivo do produtor responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /producer_net_value/signals/signalFinishFixation: post: description: Endpoint responsável pela fixação do saldo do produtor tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – charges – eventControlItemId properties: charges: type: array items: type: object allOf: – #/definitions/chargesFixed minimum: 1 description: Cargas fixadas eventControlItemId: type: string description: Condigo do item no evento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /producer_net_value/signals/signalCancelFixation: post: description: Endpoint responsável pela por cancelar movimentos da fixação tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – fixationItemId – eventControlItemId properties: fixationItemId: type: array items: type: string minimum: 1 description: Cargas fixadas eventControlItemId: type: string description: Condigo do item no evento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /producer_net_value/signals/undoingContractNewBalanceChanges: post: description: tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – effectiveId properties: effectiveId: type: string description: Id do saldo efetivo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /producer_net_value/signals/signalTransferReverseProducerBalance: post: description: tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – externalIds – eventControlItemId properties: externalIds: type: array items: type: string minimum: 1 description: Id da transferência eventControlItemId: type: string description: Condigo do item no evento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/events/importProvisionalEvent: 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 /producer_net_value/events/exportProvisionalEvent: 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 /producer_net_value/events/importEffectiveEvent: 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 /producer_net_value/events/exportEffectiveEvent: 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 /producer_net_value/events/importQuantitiesEvent: 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 /producer_net_value/events/exportQuantitiesEvent: 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 /producer_net_value/events/importContractReferenceEvent: 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 /producer_net_value/events/exportContractReferenceEvent: 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 /producer_net_value/events/importInvoiceEntryEvent: 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 /producer_net_value/events/exportInvoiceEntryEvent: 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 /producer_net_value/events/importMovementEvent: 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 /producer_net_value/events/exportMovementEvent: 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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/events/importE021motEvent: 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 /producer_net_value/events/exportE021motEvent: 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 /producer_net_value/events/importE099usuAgrSalEvent: 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 /producer_net_value/events/exportE099usuAgrSalEvent: 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 /producer_net_value/events/importBlockEvent: 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 /producer_net_value/events/exportBlockEvent: 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 /producer_net_value/events/importBlockMovementEvent: 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 /producer_net_value/events/exportBlockMovementEvent: 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 /producer_net_value/events/importProducerProtectionEvent: 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 /producer_net_value/events/exportProducerProtectionEvent: 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 /producer_net_value/events/importHolderEvent: 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 /producer_net_value/events/exportHolderEvent: 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 /producer_net_value/events/importVarietyEvent: 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 /producer_net_value/events/exportVarietyEvent: 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 /producer_net_value/events/importProductVarietyEvent: 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 /producer_net_value/events/exportProductVarietyEvent: 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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/events/importEffectiveIncreaseEvent: 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 /producer_net_value/events/exportEffectiveIncreaseEvent: 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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/entities/provisional: 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/provisional responses: 200: description: The created resource schema: #/definitions/provisional 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/provisional responses: 200: description: The created resource schema: #/definitions/provisional 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/provisional 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/provisional/{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/editProvisional responses: 200: description: Ok schema: #/definitions/editProvisional 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/provisional responses: 200: description: Ok schema: #/definitions/provisional 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/provisional 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 /producer_net_value/entities/provisional/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/provisional responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/effective: 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/effective responses: 200: description: The created resource schema: #/definitions/effective 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/effective responses: 200: description: The created resource schema: #/definitions/effective 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/effective 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/effective/{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/editEffective responses: 200: description: Ok schema: #/definitions/editEffective 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/effective responses: 200: description: Ok schema: #/definitions/effective 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/effective 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 /producer_net_value/entities/effective/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/effective responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/quantities: 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/quantities responses: 200: description: The created resource schema: #/definitions/quantities 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/quantities responses: 200: description: The created resource schema: #/definitions/quantities 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/quantities 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/quantities/{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/editQuantities responses: 200: description: Ok schema: #/definitions/editQuantities 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/quantities responses: 200: description: Ok schema: #/definitions/quantities 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/quantities 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 /producer_net_value/entities/quantities/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/quantities responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/contractReference: 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/contractReference responses: 200: description: The created resource schema: #/definitions/contractReference 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/contractReference responses: 200: description: The created resource schema: #/definitions/contractReference 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/contractReference 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/contractReference/{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/editContractReference responses: 200: description: Ok schema: #/definitions/editContractReference 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/contractReference responses: 200: description: Ok schema: #/definitions/contractReference 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/contractReference 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 /producer_net_value/entities/contractReference/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contractReference responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/invoiceEntry: 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/invoiceEntry responses: 200: description: The created resource schema: #/definitions/invoiceEntry 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/invoiceEntry responses: 200: description: The created resource schema: #/definitions/invoiceEntry 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/invoiceEntry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/invoiceEntry/{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/editInvoiceEntry responses: 200: description: Ok schema: #/definitions/editInvoiceEntry 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/invoiceEntry responses: 200: description: Ok schema: #/definitions/invoiceEntry 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/invoiceEntry 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 /producer_net_value/entities/invoiceEntry/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/invoiceEntry responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/movement: 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/movement responses: 200: description: The created resource schema: #/definitions/movement 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/movement responses: 200: description: The created resource schema: #/definitions/movement 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/movement 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/movement/{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/editMovement responses: 200: description: Ok schema: #/definitions/editMovement 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/movement responses: 200: description: Ok schema: #/definitions/movement 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/movement 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 /producer_net_value/entities/movement/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/movement responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/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 /producer_net_value/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 /producer_net_value/entities/e021mot: 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/e021mot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/e021mot/{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/e021mot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/e099usuAgrSal: 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/e099usuAgrSal responses: 200: description: The created resource schema: #/definitions/e099usuAgrSal 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/e099usuAgrSal responses: 200: description: The created resource schema: #/definitions/e099usuAgrSal 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/e099usuAgrSal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/e099usuAgrSal/{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/editE099usuAgrSal responses: 200: description: Ok schema: #/definitions/editE099usuAgrSal 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/e099usuAgrSal responses: 200: description: Ok schema: #/definitions/e099usuAgrSal 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/e099usuAgrSal 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 /producer_net_value/entities/e099usuAgrSal/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e099usuAgrSal responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/block: 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/block responses: 200: description: The created resource schema: #/definitions/block 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/block responses: 200: description: The created resource schema: #/definitions/block 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/block 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/block/{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/editBlock responses: 200: description: Ok schema: #/definitions/editBlock 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/block responses: 200: description: Ok schema: #/definitions/block 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/block 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 /producer_net_value/entities/block/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/block responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/blockMovement: 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/blockMovement responses: 200: description: The created resource schema: #/definitions/blockMovement 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/blockMovement responses: 200: description: The created resource schema: #/definitions/blockMovement 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/blockMovement 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/blockMovement/{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/editBlockMovement responses: 200: description: Ok schema: #/definitions/editBlockMovement 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/blockMovement responses: 200: description: Ok schema: #/definitions/blockMovement 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/blockMovement 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 /producer_net_value/entities/blockMovement/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/blockMovement responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/producerProtection: 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/producerProtection responses: 200: description: The created resource schema: #/definitions/producerProtection 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/producerProtection responses: 200: description: The created resource schema: #/definitions/producerProtection 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/producerProtection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/producerProtection/{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/editProducerProtection responses: 200: description: Ok schema: #/definitions/editProducerProtection 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/producerProtection responses: 200: description: Ok schema: #/definitions/producerProtection 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/producerProtection 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 /producer_net_value/entities/producerProtection/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/producerProtection responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/holder: 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/holder 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/holder/{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/holder 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/variety: 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/variety 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/variety/{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/variety 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/productVariety: 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/productVariety 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/productVariety/{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/productVariety 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/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 /producer_net_value/entities/effectiveIncrease: 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/effectiveIncrease responses: 200: description: The created resource schema: #/definitions/effectiveIncrease 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/effectiveIncrease responses: 200: description: The created resource schema: #/definitions/effectiveIncrease 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/effectiveIncrease 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /producer_net_value/entities/effectiveIncrease/{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/editEffectiveIncrease responses: 200: description: Ok schema: #/definitions/editEffectiveIncrease 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/effectiveIncrease responses: 200: description: Ok schema: #/definitions/effectiveIncrease 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/effectiveIncrease 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 /producer_net_value/entities/effectiveIncrease/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/effectiveIncrease responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down statusEntity: type: string enum: – VA – VI description: Status da Entidade: * `VA` – Ativo * `VI` – Inativo lockOperation: type: string enum: – LOCK – UNLOCK description: Operação de bloqueio: * `LOCK` – Bloqueio * `UNLOCK` – Desbloqueio fixationFormat: type: string enum: – QUANTITY – VALUE description: Formato da Fixação: * `QUANTITY` – Quantidade * `VALUE` – Valor varietyTest: type: string enum: – NOT_DECLARED – POSITIVE – NEGATIVE description: Teste de variedade: * `NOT_DECLARED` – Não Declarado * `POSITIVE` – Positivo * `NEGATIVE` – Negativo agroInvoiceType: type: string enum: – INCOMING – OUTGOING – RETURN – COMPLEMENT – SYMBOLIC_RETURN – ADJUSTMENT – SERVICE description: Tipo da nota fiscal: * `INCOMING` – Entrada * `OUTGOING` – Saída * `RETURN` – Devolução * `COMPLEMENT` – Complemento * `SYMBOLIC_RETURN` – Devolução de Simbolica * `ADJUSTMENT` – Nota de Acerto * `SERVICE` – Serviço enumTipMoe: type: string enum: – VV – VD – VP – VE – VH description: Tipo da moeda: * `VV` – Valor * `VD` – Índice * `VP` – Percentual * `VE` – Especial * `VH` – Hora originType: type: string enum: – IMMEDIATE_BUY_ENTRY – ENTRY_IN_DEPOSIT – ENTRY_TO_BE_FIXED – FIXATION – TRANSFER – DEVOLUTION – BLOCK – UNBLOCK – CONTRACT – OTHERS description: Operação: * `IMMEDIATE_BUY_ENTRY` – Compra imediata * `ENTRY_IN_DEPOSIT` – Entrada Em Deposito * `ENTRY_TO_BE_FIXED` – A fixar * `FIXATION` – Fixação * `TRANSFER` – Transferência * `DEVOLUTION` – Devolução * `BLOCK` – Bloqueio * `UNBLOCK` – Desbloqueio * `CONTRACT` – Contratos * `OTHERS` – Outros operationType: type: string enum: – ENTRY – EXIT – BLOCK – UNBLOCK – RESERVED – FIXATION – LINK – UNLINK – RELEASE_RESERVE – CANCEL_FIXATION – CANCEL_ENTRY – CANCEL_EXIT description: Tipo Operação: * `ENTRY` – Entrada * `EXIT` – Saída * `BLOCK` – Bloqueio * `UNBLOCK` – Desbloqueio * `RESERVED` – Reservado * `FIXATION` – Fixação * `LINK` – Vinculo * `UNLINK` – Desvinculo * `RELEASE_RESERVE` – Liberação da reserva * `CANCEL_FIXATION` – Cancelamento da fixação * `CANCEL_ENTRY` – Cancelamento da entrada * `CANCEL_EXIT` – Cancelamento da saída effectiveStatus: type: string enum: – PENDING – FINISHED – ERROR – CANCELLED – IN_CANCELLATION – REJECTED description: Status do registro de saldo: * `PENDING` – Pendente * `FINISHED` – Finalizado * `ERROR` – Erro * `CANCELLED` – Cancelado * `IN_CANCELLATION` – Em Cancelamento * `REJECTED` – Rejeitado enumAplMot: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 – V19 – V20 – V21 – V22 – V23 – V24 – V25 – V26 – V27 – V28 – V29 – V30 – V31 – V32 – V33 – V34 – V35 – V36 – V37 – V38 – V39 – V40 – V41 – V42 – V43 – V44 – V45 – V46 – V47 – V48 – V49 – V50 – V51 – V52 – V53 – V99 description: Aplicação dos motivos das situações das tabelas: * `V1` – Situação Clientes * `V2` – Situação Fornecedores * `V3` – Situação Representantes * `V4` – Situação Usuários * `V5` – Situação Estoques * `V6` – Situação Pedidos de Venda * `V7` – Situação Orçamentos de Venda * `V8` – Situação Notas Fiscais Saída * `V9` – Situação Ordens de Compra * `V10` – Contratos de Compra * `V11` – Situação Notas Fiscais Entrada * `V12` – Prorrog. Venc. Contas Receber * `V13` – Prorrog. Venc. Contas Pagar * `V14` – Situação Produto/Derivação * `V15` – Pré-faturas * `V16` – Tipo de movimentação de patrimônio * `V17` – Tipo de projetos * `V18` – Cotações * `V19` – Agrupamento de projetos * `V20` – Ocorrência na prestação de contas * `V21` – Veículos * `V22` – Solicitação de orçamento * `V23` – Orçamento de Produto * `V24` – Ocorrência na assistência técnica * `V25` – Devolução de solicitação de compra * `V26` – Bloqueio de ferramenta * `V27` – Concessão de sobrevida de ferramenta * `V28` – Acerto por inventário rotativo * `V29` – Funcionalidade do bem * `V30` – Ligação produto x fabricante * `V31` – Convênios * `V32` – Avalistas * `V33` – Agendamento * `V34` – Cancelamento de manutenção * `V35` – Ocorrência na montagem dos produtos * `V36` – Ocorrência para Movimentos de Estoque * `V37` – Ocorrência de sangria no PDV * `V38` – Ocorrência de movimentação de caixa no retaguarda * `V39` – Ocorrência de suprimento no PDV * `V40` – Ocorrência para serviços de frete * `V41` – Ocorrência para descontos no PDV/Retaguarda * `V42` – Ocorrência para reservas de estoque * `V43` – Ocorrência para bloqueios de estoque * `V44` – Ocorrência para movimentos de estoque de entrada * `V45` – Ocorrência para movimentos de estoque de saída * `V46` – Ocorrência para transferência de estoque * `V47` – Solicitação de compras * `V48` – Bloqueio de separação WMS * `V49` – Entrada em contingência * `V50` – Agronegócio * `V51` – Inventário – Saída do estoque * `V52` – Inventário – Entrada no estoque * `V53` – Situação contrato de venda * `V99` – Todos protectType: type: string enum: – PROTECTED – RELEASED description: Tipo de proteção do produtor: * `PROTECTED` – Protegido * `RELEASED` – Liberado balanceType: type: string enum: – PRODUCT – HARVEST – RURAL_ESTATE – CONTRACT description: Tipo de saldo: * `PRODUCT` – Produto * `HARVEST` – Safra * `RURAL_ESTATE` – Imóvel Rural * `CONTRACT` – Contrato enumTipCot: type: string enum: – VD – VM description: Tipo da cotação: * `VD` – Diária * `VM` – Mensal operation: type: string enum: – ENTRY_IN_DEPOSIT – ENTRY_TO_BE_FIXED – IMMEDIATE_BUY_ENTRY description: Tipo original de entrada, somente tres, entrada a deposito, entrada a fixar e compra imediata: * `ENTRY_IN_DEPOSIT` – Entrada a deposito * `ENTRY_TO_BE_FIXED` – Entrada a fixar * `IMMEDIATE_BUY_ENTRY` – Compra imediata typeIncrease: type: string enum: – P – V description: Tipo de Acréscimo: * `P` – Percentual * `V` – Valor 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 recPageRequest: description: Record para paginação e ordenação type: object required: – page – size properties: page: type: integer format: int64 description: Página atual size: type: integer format: int64 description: Total de registros da página orderByRequest: description: Record para receber o order by type: object required: – field – order properties: field: type: string description: Nome do campo order: type: integer format: int64 description: Ordem (Desc ou Asc) filterNfeNumber: description: Filtro para listagem de Notas Fiscais type: object properties: producer: type: string description: Id do Produtor familyGroup: type: string description: Id do Grupo Familiar product: type: string description: ID do produto nfeNumber: type: string description: Numero da Nota Fiscal nfeSerie: type: string description: Numero da Serie filterBalanceBlocks: description: Filtro para listagem dos saldos passiveis de desbloqueio type: object required: – blockId properties: blockId: type: string description: Id do Bloqueio startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final harvest: type: string description: Safra filterBlocks: description: Filtro para listagem de bloqueios type: object properties: company: type: string description: Id da Empresa producer: type: string description: Id do Produtor product: type: string description: Id do Produto reason: type: string description: Id do Motivo status: type: string allOf: – #/definitions/statusEntity description: Status do registro createdDate: type: string format: date description: Data de criação filterEffective: description: Filtro para listagem de saldos efetivos type: object required: – company – producer 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 entryType: type: array items: type: string allOf: – #/definitions/operation description: Tipo de origem da operação ruralEstate: type: string description: Imovel Rural – Origem da mercadoria blockWithProducer: description: GRID de bloqueios type: object required: – id – code – description – company – product – reason – status – quantityRequested – quantityEffective – quantityRemaining – createdDate – lastModifiedDate properties: id: type: string description: Id code: type: integer format: int64 description: Código da operação description: type: string description: Descrição da operação company: type: object allOf: – #/definitions/e070emp description: Empresa producer: type: object allOf: – #/definitions/e095pes description: ID do Produtor producerName: type: string description: Nome do Produtor producerDocument: type: string description: CNPJ/CPF do Produtor product: type: object allOf: – #/definitions/e075der description: Produto reason: type: object allOf: – #/definitions/e021mot description: Motivo da operação status: type: string allOf: – #/definitions/statusEntity description: Status do registro observation: type: string description: Observação quantityRequested: type: number format: double description: Quantidade da operação de bloqueio solicitada minimum: 0.0 quantityEffective: type: number format: double description: Quantidade da operação de bloqueio efetivada minimum: 0.0 quantityRemaining: type: number format: double description: Quantidade da operação que falta bloquear minimum: 0.0 createdDate: type: string format: date-time description: Data de criação lastModifiedDate: type: string format: date-time description: Data de alteração effectiveResult: description: DTO para detalhar informações para contratos sobre o saldo do produtor type: object required: – id – producer – entryDate – quantityEntry – quantityAvailable – quantityBlocked – quantityReserved – controlCode properties: id: type: string description: UUID producer: type: string description: Produtor entryDate: type: string format: date-time description: Data de entrada quantityEntry: type: number format: double description: Quantidade de entrada quantityAvailable: type: number format: double description: Quantidade disponível quantityBlocked: type: number format: double description: Quantidade bloqueada quantityReserved: type: number format: double description: Quantidade reservada 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 companyId: type: string description: Empressa id branchId: type: string description: Filial id producerId: type: string description: Produtor id productId: type: string description: Produto id royaltyCredits: type: number format: double description: Créditos de Royalty default: 0.0 royaltyProtocolNumber: type: integer format: int64 description: Número de protocolo do Royalty default: 0 blockBalanceItens: description: Informações sobre o movimento de item de bloqueio/desbloqueio type: object required: – balanceId – quantityRequested properties: balanceId: type: string description: ID do saldo do produtor quantityRequested: type: number format: double description: Quantidade da operação de bloqueio solicitada minimum: 0.0 operatingBalances: description: Saldos de operação type: object required: – product – quantity – ruralEstate – nfeNumber – harvest properties: product: type: string description: Produto quantity: type: number format: double description: Quantidade ruralEstate: type: string description: Origem da mercadoria nfeNumber: type: string description: Nota Fiscal de Origem harvest: type: string description: Safra effectiveOutgoingBalance: description: Dados dos saldos de origem à serem transferidos type: object required: – effectiveId – branch – transferDate – unitPrice – quantity properties: effectiveId: type: string description: ID do saldo efetivo a ser transferido branch: type: string description: ID da filial transferDate: type: string format: date-time description: Data/hora da transferência unitPrice: type: number format: double description: Preço unitário do item da nota fiscal quantity: type: number format: double description: Quantidade do item da nota fiscal externalId: type: string description: Identificador externo para que sistemas externos consigam obter informações sobre este registro transactionalInvoiceId: type: string description: Id transacional da nota fiscal effectiveIncomingBalance: description: Dados dos saldos de destino à serem criados type: object required: – companyId – branchId – transferDate – producerId – productId – harvestId – controlCode – ruralEstateId – origin – unitPrice – warehouseId – quantity properties: companyId: type: string description: ID da empresa branchId: type: string description: ID da filial transferDate: type: string format: date-time description: Data/hora da transferência producerId: type: string description: ID do Produtor productId: type: string description: ID do Produto harvestId: type: string description: ID da Safra controlCode: type: integer format: int64 description: Código da transferencia ruralEstateId: type: string description: ID do Imóvel Rural – Origem da mercadoria origin: type: string allOf: – #/definitions/originType description: Tipo de originação unitPrice: type: number format: double description: Preço unitário do item da nota fiscal warehouseId: type: string description: ID do depósito quantity: type: number format: double description: Quantidade do item da nota fiscal externalId: type: string description: Identificador externo para que sistemas externos consigam obter informações sobre este registro transactionalInvoiceId: type: string description: Id transacional da nota fiscal invoiceId: type: string description: Id da nota fiscal – caso nao encontre irá buscar pelo id transacional checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck effectiveListForProducerTransferFilter: description: Filtro para a consulta de effectives no processo de transferência entre produtores type: object required: – company – branch – producer – product 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 ruralEstate: type: string description: Id do Imóvel Rural nfeNumber: type: array items: type: string description: Número da nota fiscal de entrada do saldo nfeSeries: type: array items: type: string description: Série da nota fiscal de entrada do saldo effectiveListForProducerTransferOutput: description: Retorno para a consulta de effectives no processo de transferência entre produtores type: object properties: effectiveList: type: array items: type: object allOf: – #/definitions/effective description: Lista de effectives totalizers: type: object allOf: – #/definitions/effectiveTotalizers description: Totalizadores dos saldos effectiveTotalizers: description: Retorno contendo os totalizadores dos saldos consultados type: object properties: quantityEntry: type: number format: double description: Quantidade entrada default: 0.0 quantityAvailable: type: number format: double description: Quantidade disponível default: 0.0 quantityBlocked: type: number format: double description: Quantidade bloqueada default: 0.0 quantityReserved: type: number format: double description: Quantidade reservada default: 0.0 quantityContract: type: number format: double description: Quantidade em contrato default: 0.0 quantityCancelled: type: number format: double description: Quantidade cancelada default: 0.0 quantityFixed: type: number format: double description: Quantidade fixada default: 0.0 effectiveSimulatedWithTransferQuantity: description: type: object required: – effective properties: effective: type: object allOf: – #/definitions/effective description: Effective simulado transferQuantityApplied: type: number format: double description: Quantidade aplicada na simulação default: 0.0 searchFilters: description: Filtro padrão para detalhar informações sobre o saldo do produtor type: object required: – company properties: company: type: string description: Id da Empresa producer: type: string description: Id do Produtor familyGroup: type: string description: Id do Grupo Familiar branch: type: string description: Id da Filial product: type: string description: Id do Produto controlCode: type: integer format: int64 description: Numero do Ticket ruralEstate: type: string description: Id do Imóvel Rural harvest: type: string description: Id da Safra startDate: type: string format: date-time description: Data da entrada na balança endDate: type: string format: date-time description: Data de entrada na balança origin: type: string allOf: – #/definitions/originType description: Tipo de originação operation: type: string description: Tipo de operação status: type: string allOf: – #/definitions/effectiveStatus description: Status nfeNumber: type: string maxLength: 9 description: Número de emissão da nota fiscal que efetivou o movimento nfeSeries: type: string maxLength: 10 description: Número da serie de emissão da nota fiscal que efetivou o movimento startDateNF: type: string format: date-time description: Data/hora em que ocorreu a emissão da nota fiscal que efetivou o movimento endDateNF: type: string format: date-time description: Data/hora em que ocorreu a emissão da nota fiscal que efetivou o movimento effectiveId: type: string description: Id do saldo efetivo privateRecord: type: boolean description: Registro privado default: false netValueSummary: description: Resumo do saldo do produtor type: object required: – productName – productId properties: productName: type: string description: Nome do Produto productId: type: string description: ID do Produto expectedEntryQuantity: type: number format: double description: Quantidade Entrada Prevista default: 0.0 effectiveEntryQuantity: type: number format: double description: Quantidade Entrada Efetiva default: 0.0 availableQuantity: type: number format: double description: Quantidade disponível default: 0.0 blockedQuantity: type: number format: double description: Quantidade bloqueada default: 0.0 reservedQuantity: type: number format: double description: Quantidade reservada default: 0.0 effectiveSummaryByFilterType: description: Resumo do saldo efetivo por tipo de filtro (Produtor, Safra, Imóvel Rural, Contrato) type: object required: – productName – productId – companyId – branchId – filterName – filterId – charges properties: productName: type: string description: Nome do Produto productId: type: string description: ID do Produto companyId: type: string description: ID da Empresa branchId: type: string description: ID da filial filterName: type: string description: Nome do retorno do filtro filterId: type: string description: fiterId effectiveEntryQuantity: type: number format: double description: Quantidade Entrada Efetiva default: 0.0 availableQuantity: type: number format: double description: Quantidade disponível default: 0.0 blockedQuantity: type: number format: double description: Quantidade bloqueada default: 0.0 reservedQuantity: type: number format: double description: Quantidade reservada default: 0.0 charges: type: array items: type: object allOf: – #/definitions/chargesToBeFixed minimum: 1 description: Dados necessários para cálculo de taxas groupedEffectiveTotalizers: description: type: object required: – filterId properties: producerId: type: string description: id do produtor productName: type: string description: Nome do Produto productId: type: string description: ID do Produto companyId: type: string description: ID da Empresa branchId: type: string description: ID da filial filterName: type: string description: Nome do filtro agrupador filterId: type: string description: Id do filtro agrupador quantityEntry: type: number format: double description: Quantidade entrada default: 0.0 quantityAvailable: type: number format: double description: Quantidade disponível default: 0.0 quantityBlocked: type: number format: double description: Quantidade bloqueada default: 0.0 quantityReserved: type: number format: double description: Quantidade reservada default: 0.0 quantityContract: type: number format: double description: Quantidade em contrato default: 0.0 quantityCancelled: type: number format: double description: Quantidade cancelada default: 0.0 quantityFixed: type: number format: double description: Quantidade fixada default: 0.0 chargesToBeFixed: description: Cargas a serem fixadas type: object required: – effectiveId – effectiveDate – harvest – quantityEntry – quantityAvailable properties: effectiveId: type: string description: Identificador de carga/saldo effectiveDate: type: string format: date-time description: Data de entrada da carga/saldo harvest: type: string description: Identificador da Safra quantityEntry: type: number format: double description: Quantidade de entrada minimum: 0.0 quantityAvailable: type: number format: double description: Quantidade disponível minimum: 0.0 productVarietyId: type: string description: Identificador da Ligação Produto x Variedade chargesFixed: description: Cargas fixadas type: object required: – effectiveId – fixationItemId – quantityFixed properties: effectiveId: type: string description: Identificador de carga/saldo fixationItemId: type: string description: Identificador do item da fixação quantityFixed: type: number format: double description: Quantidade fixada minimum: 0.0 nfeNumber: type: string description: Numero da Nota Fiscal nfeSeries: type: string description: Série da Nota Fiscal nfeKey: type: string description: Chave da Nota Fiscal transactionalInvoiceId: type: string description: Id transacional da Nota Fiscal netValueMovementDetails: description: Detalhes das movimentações do saldo do produtor type: object properties: effectiveEntryQuantity: type: number format: double description: Quantidade Entrada Efetiva default: 0.0 availableQuantity: type: number format: double description: Quantidade disponível default: 0.0 blockedQuantity: type: number format: double description: Quantidade bloqueada default: 0.0 reservedQuantity: type: number format: double description: Quantidade reservada default: 0.0 fixedQuantity: type: number format: double description: Quantidade fixada default: 0.0 balanceTotals: description: Record balanceTotals type: object properties: effective: type: number format: double description: Quantidade Efetiva default: 0.0 available: type: number format: double description: Quantidade Disponível default: 0.0 blocked: type: number format: double description: Quantidade Bloqueada default: 0.0 reserved: type: number format: double description: Quantidade Reservada default: 0.0 fixedQuantity: type: number format: double description: Quantidade fixada default: 0.0 linkFirstBalanceInput: description: Record para envio dos dados na integração com agro/contract/linkFirstBalanceInput type: object 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 linkFirstBalanceOutput: description: Record para retorno dos dados na integração com agro/contract/linkFirstBalanceOutput type: object properties: success: type: boolean description: sucesso message: type: string description: mensagem de retorno getInvoiceByTransacionalIdInput: description: Record para envio dos dados na integração com agro/invoice/getInvoiceByTransacionalId type: object properties: transactionalId: type: string description: Id da nota fiscal branchId: type: string description: Id da filial getInvoiceByTransacionalIdOutput: description: Record para retorno dos dados na integração com agro/invoice/getInvoiceByTransacionalId type: object properties: invoice: type: object allOf: – #/definitions/invoiceReceived description: Nota fiscal getInvoiceByInvoiceERPXIdInput: description: Record para envio dos dados na integração com agro/invoice/getInvoiceByInvoiceERPXId type: object properties: invoiceErpxId: type: string description: Id da nota fiscal no ERPX branchId: type: string description: Id da filial getInvoiceByInvoiceERPXIdOutput: description: Record para retorno dos dados na integração com agro/invoice/getInvoiceByInvoiceERPXIdO type: object properties: invoice: type: object allOf: – #/definitions/invoiceReceived description: Nota fiscal invoiceReceived: description: Record para retorno de notas fiscais consultadas type: object properties: number: type: string maxLength: 9 description: Número series: type: string maxLength: 3 description: Série issuanceDate: type: string format: date-time description: Data de emissão type: type: string allOf: – #/definitions/agroInvoiceType description: Tipo key: type: string maxLength: 44 description: Chave eletrônica items: type: array items: type: object allOf: – #/definitions/invoiceItem description: Itens de nota fiscal getInvoiceErpxIdByGroupedProducerInvoiceIdInput: description: Record para envio dos dados na integração com agro/origination/getInvoiceErpxIdByGroupedProducerInvoiceId type: object properties: producerInvoiceId: type: string description: Id de ProducerInvoice getInvoiceErpxIdByGroupedProducerInvoiceIdOutput: description: Record para retorno dos dados na integração com agro/origination/getInvoiceErpxIdByGroupedProducerInvoiceId type: object properties: invoiceErpxId: type: string description: Id da nota fiscal no ERPX classificationInput: description: Record para envio dos dados na integração com o agro/classification/entities/{id} type: object properties: id: type: string description: Id da classificação classification: description: Record para retorno dos dados na integração com o agro/classification/entities/{id} type: object properties: id: type: string description: Id da classificação productVariety: type: object allOf: – #/definitions/productVariety description: Variedade varietyTest: type: string allOf: – #/definitions/varietyTest description: Teste da variedade classificationDetail: description: Record para envio dos dados na integração com o agro/classificationDetail/entities/{id} type: object required: – typeIncrease – valIncIncrease properties: id: type: string description: Id da classificação increaseProduct: type: object allOf: – #/definitions/increaseProduct description: acrescimo finaceiro typeIncrease: type: string allOf: – #/definitions/typeIncrease description: Tipo de acrescimo valIncIncrease: type: number format: double description: Valor do acréscimo invoiceItem: description: Itens da nota fiscal type: object required: – productId – quantity – unitPrice properties: productId: type: string description: Id do produto item: type: string maxLength: 9 description: Item quantity: type: number format: double description: Quantity unitPrice: type: number format: double description: Unit price contractExternalInvoice: type: string description: id do contract_external_invoice setProcessingStatusInput: description: Record referente ao envio da integração com o serviço agro/agro_events SetProcessingStatus type: object properties: eventControlItemId: type: string description: Id do item de evento setSuccessStatusInput: description: Record referente ao envio da integração com o serviço agro/agro_events SetSuccessStatus type: object properties: eventControlItemId: type: string description: Id do item de evento setFailedStatusInput: description: Record referente ao envio da integração com o serviço agro/agro_events SetFailedStatus type: object properties: eventControlItemId: type: string description: Id do item de evento message: type: string description: Mensagem de erro chargesToBeReserved: description: Cargas a serem reservadas type: object required: – effectiveId – quantityToBeReserved – origin properties: effectiveId: type: string description: Identificador de carga/saldo quantityToBeReserved: type: number format: double description: Quantidade a ser reservada minimum: 0.0 externalId: type: string description: Relacionar a reserva com um id externo origin: type: string allOf: – #/definitions/originType description: Origem da reserva listInvoicesByTransactionalIdInput: description: Record para envio dos dados na integração com agro/invoice/listInvoicesByTransactionalId type: object properties: transactionalId: type: string description: Id da nota fiscal branchId: type: string description: Id da filial listInvoicesByTransactionalIdOutput: description: Record para retorno de dados na integração com agro/invoice/listInvoicesByTransactionalId type: object properties: invoices: type: array items: type: object allOf: – #/definitions/invoice description: Nota fiscal invoice: description: Record com com informações da nota gerais da nota type: object required: – id properties: id: type: string description: Id number: type: string maxLength: 9 description: Número series: type: string maxLength: 3 description: Série issuanceDate: type: string format: date-time description: Data de emissão status: type: string description: Status type: type: string allOf: – #/definitions/agroInvoiceType description: Tipo key: type: string maxLength: 44 description: Chave eletrônica invoiceDetailRecord: description: Detalhe do movimento de saldo efetivo efetuado pela NF type: object required: – issuanceDate – key – item – unitPrice – quantity properties: invoiceId: type: string description: Id da nota number: type: integer format: int64 description: Número series: type: string description: Código de cadastro da série seriesId: type: string description: Id de cadastro da série seriesLegal: type: string description: Série legal utilizada na SEFAZ issuanceDate: type: string format: date-time description: Data emissão da NF key: type: string description: Chave da NF item: type: integer format: int64 description: Numero do item da NF minimum: 1 unitPrice: type: string description: Preço unitário minimum: 0.0 quantity: type: number format: double description: Quantidade do item minimum: 0.0 warehouseId: type: string description: Depósito contractRecord: description: Contrato vinculado ao saldo do produtor type: object properties: contractId: type: string description: Contrato vinculado ao item da NF contractProductId: type: string description: Contrato vinculado ao produto contractProductProducerId: type: string description: Contrato vinculado ao produtor royaltyRecord: description: Informações sobre o credito de royalty do produtor type: object properties: credits: type: number format: double description: Créditos de Royalties minimum: 0.0 protocolNumber: type: integer format: int64 description: Numero do protocolo minimum: 0 e070emp: description: Empresa type: object required: – codEmp – nomEmp – sigEmp properties: id: type: string format: uuid description: Id 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 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 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: 14 description: CNPJ/CPF sitPes: 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: e095pes: description: Fornecedor type: object required: – sitFor properties: id: type: string format: uuid description: Id 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: 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: 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: e031moe: description: Moedas type: object required: – codMoe – desMoe – sigMoe – tipMoe – tipCot properties: id: type: string format: uuid description: Id codMoe: type: string maxLength: 3 description: Codigo 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: Quatidade de inteiros minimum: 0 maximum: 13 qtdDec: type: integer format: int64 description: Quantidade de decimais minimum: 1 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: e031smo: description: Série de cotação da moeda type: object required: – codSmo properties: id: type: string format: uuid description: Id 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: 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 preco cotacao 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 derviaçã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: 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: provisional: description: Entidade de saldo provisório do produtor type: object required: – company – branch – entryDate – producer – product – quantityEntry – harvest – controlCode – ruralEstate properties: id: type: string format: uuid description: UUID company: type: object allOf: – #/definitions/e070emp description: Código da empresa branch: type: object allOf: – #/definitions/e070fil description: Filial entryDate: type: string format: date-time description: Data de entrada producer: type: object allOf: – #/definitions/e095pes description: Produtor product: type: object allOf: – #/definitions/e075der description: Produto quantityEntry: type: number format: double description: Quantidade de entrada minimum: 0.0 harvest: type: object allOf: – #/definitions/e113saf description: Safra currency: type: object allOf: – #/definitions/e031moe description: Moeda controlCode: type: integer format: int64 description: Codigo do romaneio/ticket ruralEstate: type: object allOf: – #/definitions/ruralEstate description: Imovel Rural – Origem da mercadoria externalID: type: string description: Id externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editProvisional: type: object required: – id allOf: – #/definitions/provisional effective: description: Entidade de saldo provisório do produtor type: object required: – company – branch – entryDate – producer – product – harvest – controlCode – ruralEstate – quantities – status properties: id: type: string format: uuid description: UUID company: type: object allOf: – #/definitions/e070emp description: Código da empresa branch: type: object allOf: – #/definitions/e070fil description: Filial entryDate: type: string format: date-time description: Data de entrada producer: type: object allOf: – #/definitions/e095pes description: Produtor product: type: object allOf: – #/definitions/e075der description: Produto harvest: type: object allOf: – #/definitions/e113saf description: Safra currency: type: object allOf: – #/definitions/e031moe description: Moeda controlCode: type: integer format: int64 description: Codigo do romaneio/ticket ruralEstate: type: object allOf: – #/definitions/ruralEstate description: Imovel Rural – Origem da mercadoria quantities: type: object allOf: – #/definitions/quantities description: Quantidades vinculados ao saldo contractReference: type: object allOf: – #/definitions/contractReference description: Contrato vinculado ao saldo invoiceEntry: type: object allOf: – #/definitions/invoiceEntry description: Nota fiscal vinculada ao saldo status: type: string allOf: – #/definitions/effectiveStatus description: Status do registro de saldo effectiveReference: type: string format: uuid description: Id do registro que originou o saldo entryType: type: string allOf: – #/definitions/operation description: Tipo de operação de entrada original vinda da originacao productVariety: type: object allOf: – #/definitions/productVariety description: Ligação Produto x Variedade varietyTest: type: string allOf: – #/definitions/varietyTest description: Teste da variedade royaltyCredits: type: number format: double description: Créditos de Royalty default: 0.0 royaltyProtocolNumber: type: integer format: int64 description: Número de protocolo do Royalty default: 0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEffective: type: object required: – id allOf: – #/definitions/effective quantities: description: Entidade com as quantidades do saldo type: object required: – firstQuantityEntry – quantityEntry – quantityAvailable – quantityCancelled – quantityBlocked – quantityReserved – quantityFixed – quantityLinkedContract properties: id: type: string format: uuid description: UUID firstQuantityEntry: type: number format: double description: Quantidade da primeira entrada minimum: 0.0 quantityEntry: type: number format: double description: Quantidade de entrada minimum: 0.0 quantityAvailable: type: number format: double description: Quantidade disponivel minimum: 0.0 quantityCancelled: type: number format: double description: Quantidade cancelada minimum: 0.0 quantityBlocked: type: number format: double description: Quantidade bloqueada minimum: 0.0 quantityReserved: type: number format: double description: Quantidade reservada minimum: 0.0 quantityFixed: type: number format: double description: Quantidade fixada minimum: 0.0 quantityLinkedContract: type: number format: double description: Quantidade vinculada em contrato minimum: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editQuantities: type: object required: – id allOf: – #/definitions/quantities contractReference: description: Entidade com dados do contrato vinculados ao saldo efetivo type: object properties: id: type: string format: uuid description: UUID contract: type: string format: uuid description: Id do contrato contractProduct: type: string format: uuid description: Id do produto do contrato contractProductProducer: type: string format: uuid description: Id do produtor do contrato createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editContractReference: type: object required: – id allOf: – #/definitions/contractReference invoiceEntry: description: Entidade com dados da nota fiscal vinculada ao saldo efetivo type: object required: – unitPriceReceipt properties: id: type: string format: uuid description: UUID nfeId: type: string format: uuid description: Id da nota fiscal de entrada – do serviço de invoice nfeKey: type: string maxLength: 44 description: Chave da nota fiscal nfeNumber: type: string maxLength: 9 description: Número de emissão da nota fiscal nfeItem: type: string maxLength: 30 description: Item da nota fiscal nfeSeries: type: string maxLength: 30 description: Número da série de emissão da nota fiscal nfeSeriesId: type: string format: uuid description: Id de cadastro da série nfeSeriesLegal: type: string description: Série legal utilizada na SEFAZ unitPriceReceipt: type: number format: double description: Preço unitário do item da nota fiscal minimum: 0.0 warehouseId: type: string format: uuid description: Depósito createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editInvoiceEntry: type: object required: – id allOf: – #/definitions/invoiceEntry movement: description: Entidade de saldo provisório do produtor type: object required: – effective – company – branch – origin – operation – movementDate – quantity properties: id: type: string format: uuid description: UUID effective: type: object allOf: – #/definitions/effective description: Chave única da tabela effective blockMovement: type: object allOf: – #/definitions/blockMovement description: Movimentos de Bloqueio company: type: object allOf: – #/definitions/e070emp description: Código da empresa branch: type: object allOf: – #/definitions/e070fil description: Filial origin: type: string allOf: – #/definitions/originType description: Tipo de originação operation: type: string allOf: – #/definitions/operationType description: Tipo de operação movementDate: type: string format: date-time description: Data/hora do movimento quantity: type: number format: double description: Quantidade minimum: 0.0 nfeKey: type: string maxLength: 44 description: Chave da nota fiscal que efetivou o movimento nfeNumber: type: string maxLength: 9 description: Número de emissão da nota fiscal que efetivou o movimento nfeSeries: type: string maxLength: 30 description: Número da serie de emissão da nota fiscal que efetivou o movimento nfeSeriesId: type: string format: uuid description: Id de cadastro da série nfeSeriesLegal: type: string description: Série legal utilizada na SEFAZ nfeDate: type: string format: date-time description: Data/hora em que ocorreu a emissão da nota fiscal que efetivou o movimento cancellationDate: type: string format: date-time description: Data/hora do cancelamento do movimento feito reason: type: string description: Campo destinado para armazenar os motivos de possíveis rejeições/erros ou justificativas para os cancelamentos feitos externalId: type: string description: Identificador externo para que sistemas externos consigam obter informações sobre este registro priceUnitInvoice: type: number format: double description: Preço unitário do item da nota fiscal nfeItem: type: string description: Código do item na nota fiscal warehouseId: type: string format: uuid description: Depósito privateRecord: type: boolean description: Registro privado – Indica se o registro é privado ou público para exibição em telas e relatórios default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editMovement: type: object required: – id allOf: – #/definitions/movement 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: e021mot: description: Motivo das situações type: object required: – codMot – desMot properties: id: type: string format: uuid description: Id codMot: type: integer format: int64 description: Código do motivo da observação ou situação maximum: 999999 desMot: type: string maxLength: 30 description: Descrição do motivo da observação ou situação aplMot: type: string allOf: – #/definitions/enumAplMot description: Aplicação dos motivos das situações das tabelas textoPadrao: type: string maxLength: 2000 description: Texto padrão do motivo de situação específica 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: e099usuAgrSal: description: Definições de usuário por empresa type: object required: – e070emp – codUsu – nomUsu properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Id da empresa codUsu: type: string description: nome do usuário nomUsu: type: string description: nome do usuário allowBlock: type: boolean description: Permite bloqueio de saldo default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editE099usuAgrSal: type: object required: – id allOf: – #/definitions/e099usuAgrSal block: description: Entidade de bloqueio de saldo type: object required: – code – description – company – producer – product – reason – status – quantityRequested – quantityEffective – quantityRemaining properties: id: type: string format: uuid description: Id code: type: integer format: int64 description: Código do bloqueio description: type: string description: Descrição do bloqueio company: type: object allOf: – #/definitions/e070emp description: Empresa producer: type: object allOf: – #/definitions/e095pes description: Produtor product: type: object allOf: – #/definitions/e075der description: Produto reason: type: object allOf: – #/definitions/e021mot description: Motivo da operação status: type: string allOf: – #/definitions/statusEntity description: Status do registro observation: type: string description: Observação quantityRequested: type: number format: double description: Quantidade da operação de bloqueio solicitada minimum: 0.0 quantityEffective: type: number format: double description: Quantidade da operação de bloqueio efetivada minimum: 0.0 quantityRemaining: type: number format: double description: Quantidade da operação que falta bloquear minimum: 0.0 blockEntry: type: boolean description: Bloqueia carga na entrada caso não tenha saldo default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editBlock: type: object required: – id allOf: – #/definitions/block blockMovement: description: Entidade da movimentação de bloqueio de saldo type: object required: – sequence – block – quantity properties: id: type: string format: uuid description: Id sequence: type: integer format: int64 description: Sequencia block: type: object allOf: – #/definitions/block description: Bloqueio operation: type: string allOf: – #/definitions/lockOperation description: Operação de bloqueio quantity: type: number format: double description: Quantidade da operação minimum: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editBlockMovement: type: object required: – id allOf: – #/definitions/blockMovement producerProtection: description: Entidade para controlar a proteção do produtor type: object required: – producer – status – dateProtect properties: id: type: string format: uuid description: Id producer: type: object allOf: – #/definitions/e095pes description: Produtor status: type: string allOf: – #/definitions/protectType description: Status dateProtect: type: string format: date-time description: Data e Hora createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editProducerProtection: type: object required: – id allOf: – #/definitions/producerProtection holder: description: Detentora da tecnologia type: object required: – code – name – techHolder properties: id: type: string format: uuid description: ID code: type: string maxLength: 10 description: Código da detentora da tecnologia name: type: string description: Nome da detentora da tecnologia techHolder: type: object allOf: – #/definitions/e095pes description: Fornecedora da tecnologia 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: variety: description: Entidade para armazenar as Variedades type: object required: – code – description – status – holder properties: id: type: string format: uuid description: Id code: type: string maxLength: 255 description: Código description: type: string maxLength: 255 description: Descrição status: type: string allOf: – #/definitions/statusEntity description: Status holder: type: object allOf: – #/definitions/holder description: Detentora da tecnologia 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: productVariety: description: Ligação produto x variedade type: object required: – e070emp – e075der – variety – royaltiesPercentage – status properties: id: type: string format: uuid description: ID e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e075der: type: object allOf: – #/definitions/e075der description: Produto variety: type: object allOf: – #/definitions/variety description: Variedade royaltiesPercentage: type: number format: double description: Percentual de royalties status: type: string allOf: – #/definitions/statusEntity description: Status e001tns: type: string format: uuid description: Transação de royalties e002tpt: type: string format: uuid description: Tipo de título e023crp: type: string format: uuid description: Grupo de contas a receber ou pagar 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: increase: description: Acréscimo Financeiro type: object required: – company – codInc – desInc – sitInc 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 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: effectiveIncrease: description: Relacionamento do acrescimo com o saldo type: object required: – effective – increaseProduct – valInc – typeIncrease properties: id: type: string format: uuid description: effective: type: object allOf: – #/definitions/effective description: Saldo increaseProduct: type: object allOf: – #/definitions/increaseProduct description: Acréscimo valInc: type: number format: double description: Valor do acréscimo typeIncrease: type: string allOf: – #/definitions/typeIncrease description: Tipo de acréscimo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEffectiveIncrease: type: object required: – id allOf: – #/definitions/effectiveIncrease notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage