2.0info: 1.42.1 Contratos description: Serviço de contratos x-senior-domain: Gestão de Contratos x-senior-domain-path: erpx_ctr x-senior-service-path: foundation_agreement 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/erpx_ctrsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /foundation_agreement/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: 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: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: 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 /foundation_agreement/queries/listAgreementHeaderCustom: post: description: Listar o cabeçalho dos contratos cadastrados\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/listAgreementHeaderCustom – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – page properties: company: type: array items: type: object allOf: – #/definitions/companyDataInput description: Permite filtrar os contratos por empresas, através do identificador ou código branch: type: array items: type: object allOf: – #/definitions/branchDataInput description: Permite filtrar os contratos por filiais, através do identificador, código ou CNPJ/CPF person: type: array items: type: object allOf: – #/definitions/personDataInput description: Permite filtrar os contratos por pessoas, através do identificador, código ou CNPJ/CPF module: type: string allOf: – #/definitions/enumAgreementModule description: Permite filtrar os contratos por módulo type: type: string allOf: – #/definitions/enumAgreementType description: Permite filtrar os contratos por tipo number: type: integer format: int64 description: Permite selecionar um contrato pelo seu número issueDateFrom: type: string format: date description: Permite filtrar os contratos a partir de uma data de emissão issueDateTo: type: string format: date description: Permite filtrar os contratos até uma data de emissão recurrence: type: string allOf: – #/definitions/enumAgreementRecurrence description: Permite filtrar os contratos pela recorrência status: type: string allOf: – #/definitions/enumAgreementStatus description: Permite filtrar os contratos pela situação installmentDateFrom: type: string format: date description: Permite filtrar os contratos a partir de uma data de vencimento da competência installmentDateTo: type: string format: date description: Permite filtrar os contratos até uma data de vencimento da competência installmentStatus: type: array items: type: string allOf: – #/definitions/enumInstallmentStatus description: Permite filtrar os contratos pela situação da competência readjustmentIndex: type: object allOf: – #/definitions/indexDataInput description: Permite filtrar os contratos pelo índice de reajuste readjustmentDate: type: string format: date description: Permite filtrar os contratos através da data do próximo reajuste(MM/AAAA) page: type: object allOf: – #/definitions/page description: Dados da paginação situationReason: type: array items: type: object allOf: – #/definitions/reasonDataInput description: Motivo de situação específica do contrato billingDateFrom: type: string format: date description: Permite filtrar os contratos a partir de uma data base de faturamento da competência billingDateTo: type: string format: date description: Permite filtrar os contratos até uma data base de faturamento da competência daysToEndAgreement: type: integer format: int64 description: Quantidade de dias para o término do contrato expiredAgreement: type: boolean description: Buscar contratos vencidos description: type: string description: Descrição do contrato responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/agreementHeaderOutput description: Lista com os registros encontrados 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/getAgreementHeader: post: description: Obter os dados do cabeçalho de um contrato\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getAgreementHeader – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador responses: 200: description: Ok schema: type: object allOf: – #/definitions/agreementHeaderOutput 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError get: description: Obter os dados do cabeçalho de um contrato\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getAgreementHeader – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Identificador in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/agreementHeaderOutput 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/listAgreementTermCustom: post: description: Listar as vigências de um contrato\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/listAgreementTermCustom – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – agreementId – page properties: agreementId: type: string description: Identificador do cabeçalho do contrato startDateFrom: type: string format: date description: Permite filtrar as vigências a partir de uma data de início finalDateTo: type: string format: date description: Permite filtrar as vigências até uma data de fim finishingDateFrom: type: string format: date description: Permite filtrar as vigências a partir de uma data de encerramento finishingDateTo: type: string format: date description: Permite filtrar as vigências até uma data de encerramento status: type: string allOf: – #/definitions/enumAgreementTermStatus description: Permite filtrar as vigências pela situação page: type: object allOf: – #/definitions/page description: Dados da paginação responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/agreementTermDataOutput description: Lista com os registros encontrados 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/getAgreementTerm: post: description: Obter os dados de uma vigência específica\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getAgreementTerm – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador da vigência responses: 200: description: Ok schema: type: object allOf: – #/definitions/agreementTermDataOutput 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError get: description: Obter os dados de uma vigência específica\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getAgreementTerm – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Identificador da vigência in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/agreementTermDataOutput 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/listTermItemCustom: post: description: Listar os itens de uma vigência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/listTermItemCustom – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – termId – page properties: termId: type: string description: Identificador da vigência itemProduct: type: array items: type: object allOf: – #/definitions/productDataInput description: Permite filtrar os itens por produto, através do identificador ou código itemService: type: array items: type: object allOf: – #/definitions/serviceDataInput description: Permite filtrar os itens por serviço, através do identificador ou código transaction: type: array items: type: object allOf: – #/definitions/transactionDataInput description: Permite filtrar os itens por transação, através do identificador ou código measureUnit: type: array items: type: object allOf: – #/definitions/measureUnitDataInput description: Permite filtrar os itens pela unidade de medida, através do identificador ou código page: type: object allOf: – #/definitions/page description: Dados da paginação responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/itemDataOutput description: Lista com os registros encontrados 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/getTermItem: post: description: Obter os dados de um item de uma vigência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getTermItem – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do item responses: 200: description: Ok schema: type: object allOf: – #/definitions/itemDataOutput 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError get: description: Obter os dados de um item de uma vigência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getTermItem – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Identificador do item in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/itemDataOutput 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/getTermInstallment: post: description: Obter os dados de um competência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getTermInstallment – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador da competência responses: 200: description: Ok schema: type: object allOf: – #/definitions/termInstallmentDataOutput 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError get: description: Obter os dados de um competência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getTermInstallment – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Identificador da competência in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/termInstallmentDataOutput 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/getInstallmentItem: post: description: Obter os dados de um item de uma competência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getInstallmentItem – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do item responses: 200: description: Ok schema: type: object allOf: – #/definitions/itemDataOutput 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError get: description: Obter os dados de um item de uma competência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getInstallmentItem – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Identificador do item in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/itemDataOutput 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/listTermInstallmentCustom: post: description: Listar as competências de uma vigência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/listTermInstallmentCustom – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – termId – page properties: termId: type: string description: Identificador da vigência dueDateFrom: type: string format: date description: Permite filtrar as competências a partir de uma data de vencimento dueDateTo: type: string format: date description: Permite filtrar as competências até uma data de vencimento installmentDateFrom: type: string format: date description: Permite filtrar as competências a partir de uma data de competência installmentDateTo: type: string format: date description: Permite filtrar as competências até uma data de competência paymentMethod: type: array items: type: object allOf: – #/definitions/paymentMethodDataInput description: Permite filtrar por formas de pagamento, através do identificador ou código netValue: type: string description: Valor da competência status: type: array items: type: string allOf: – #/definitions/enumInstallmentStatus description: Situação da competência invoiceStatus: type: array items: type: string allOf: – #/definitions/enumInvoiceStatus description: Situação documento fiscal chargePaymentStatus: type: array items: type: string allOf: – #/definitions/enumChargePaymentStatus description: Situação cobrança overduePayment: type: boolean description: Cobrança em atraso page: type: object allOf: – #/definitions/page description: Dados da paginação responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/termInstallmentDataOutput description: Lista com os registros encontrados 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/listInstallmentItemCustom: post: description: Listar os itens de uma competência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/listInstallmentItemCustom – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – installmentId – page properties: installmentId: type: string description: Identificador da competência itemProduct: type: array items: type: object allOf: – #/definitions/productDataInput description: Permite filtrar os itens por produto, através do identificador ou código itemService: type: array items: type: object allOf: – #/definitions/serviceDataInput description: Permite filtrar os itens por serviço, através do identificador ou código transaction: type: array items: type: object allOf: – #/definitions/transactionDataInput description: Permite filtrar os itens por transação, através do identificador ou código measureUnit: type: array items: type: object allOf: – #/definitions/measureUnitDataInput description: Permite filtrar os itens pela unidade de medida, através do identificador ou código page: type: object allOf: – #/definitions/page description: Dados da paginação responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/itemDataOutput description: Lista com os registros encontrados 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/getInstallmentChargePayment: post: description: Obter informações de cobrança da competência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getInstallmentChargePayment – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – installmentId – page properties: installmentId: type: string description: Identificador da competência page: type: object allOf: – #/definitions/page description: Dados da paginação responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/installmentChargePaymentOutput description: Lista com os registros encontrados 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/getInstallmentInvoice: post: description: Listar informações das notas fiscais da competência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getInstallmentInvoice – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – installmentId – page properties: installmentId: type: string description: Identificador da competência page: type: object allOf: – #/definitions/page description: Dados da paginação responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/installmentInvoiceOutput description: Lista de notas fiscais da competência 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/getTermStatus: post: description: Retornar a situação da vigência e o log de erro (se existir)\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getTermStatus – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – termId properties: termId: type: string description: Id da vigência responses: 200: description: Ok schema: type: object properties: termId: type: string description: Id da vigência status: type: string allOf: – #/definitions/enumAgreementTermStatus description: Situação da vigência installmentError: type: string description: Mensagem de erro da geração das competências 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError get: description: Retornar a situação da vigência e o log de erro (se existir)\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getTermStatus – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: termId description: Id da vigência in: query required: true type: string responses: 200: description: Ok schema: type: object properties: termId: type: string description: Id da vigência status: type: string allOf: – #/definitions/enumAgreementTermStatus description: Situação da vigência installmentError: type: string description: Mensagem de erro da geração das competências 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/getChargePaymentOpened: post: description: Retornar se o contrato possui cobranças/pagamentos em aberto\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getChargePaymentOpened – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do contrato responses: 200: description: Ok schema: type: object required: – hasChargePaymentOpened properties: hasChargePaymentOpened: type: boolean description: Indicativo se possui cobranças/pagamentos em aberto 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError get: description: Retornar se o contrato possui cobranças/pagamentos em aberto\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getChargePaymentOpened – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Id do contrato in: query required: true type: string responses: 200: description: Ok schema: type: object required: – hasChargePaymentOpened properties: hasChargePaymentOpened: type: boolean description: Indicativo se possui cobranças/pagamentos em aberto 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/getInstallmentSummary: post: description: Retornar a quantidade de competências que serão geradas\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getInstallmentSummary – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: termId: type: string description: Id da vigência responses: 200: description: Ok schema: type: object properties: quantity: type: integer format: int64 description: Quantidade de competências initialDate: type: string format: date description: Data da primeira competência finalDate: type: string format: date description: Data da última competência 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError get: description: Retornar a quantidade de competências que serão geradas\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getInstallmentSummary – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: termId description: Id da vigência in: query type: string responses: 200: description: Ok schema: type: object properties: quantity: type: integer format: int64 description: Quantidade de competências initialDate: type: string format: date description: Data da primeira competência finalDate: type: string format: date description: Data da última competência 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/getAgreementOrderItem: post: description: Devolver informações do contrato para o item da nota fiscal\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getAgreementOrderItem – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – installmentItemId properties: installmentItemId: type: string description: Identificador do item da competência responses: 200: description: Ok schema: type: object required: – code – tradeName – number – description – agreementId properties: code: type: integer format: int64 description: Código da filial tradeName: type: string description: Nome fantasia da filial number: type: integer format: int64 description: Número do contrato description: type: string description: Descrição da competência agreementId: type: string description: Id da Ordem 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError get: description: Devolver informações do contrato para o item da nota fiscal\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/getAgreementOrderItem – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: installmentItemId description: Identificador do item da competência in: query required: true type: string responses: 200: description: Ok schema: type: object required: – code – tradeName – number – description – agreementId properties: code: type: integer format: int64 description: Código da filial tradeName: type: string description: Nome fantasia da filial number: type: integer format: int64 description: Número do contrato description: type: string description: Descrição da competência agreementId: type: string description: Id da Ordem 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/suggestAgreementTerm: post: description: Efetuar a sugestão da data de inicio e fim da vigência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agreementHeaderId properties: agreementHeaderId: type: string description: Id do contrato responses: 200: description: Ok schema: type: object properties: startDate: type: string format: date description: Data de início finalDate: type: string format: date description: Data de término 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Efetuar a sugestão da data de inicio e fim da vigência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: agreementHeaderId description: Id do contrato in: query required: true type: string responses: 200: description: Ok schema: type: object properties: startDate: type: string format: date description: Data de início finalDate: type: string format: date description: Data de término 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/getPredefinedTermItemInformation: post: description: Efetua sugestão das informações do item tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId – branchId – itemType – customerId properties: companyId: type: string description: Id da Empresa branchId: type: string description: Id da filial itemType: type: string allOf: – #/definitions/enumProSer description: Tipo do item productId: type: string description: Id do Produto serviceId: type: string description: Id do Servico customerId: type: string description: Id do cliente baseDate: type: string format: date description: Data base priceListId: type: string description: Id da tabela de preço saleMeasureUnitId: type: string description: Unidade de medida de venda responses: 200: description: Ok schema: type: object properties: priceList: type: object allOf: – #/definitions/defaultDataOutput description: Dados da tabela de preço transaction: type: object allOf: – #/definitions/defaultDataOutput description: Dados da transação saleMeasureUnit: type: object allOf: – #/definitions/saleMeasureUnitOutput description: Dados da unidade de medida de venda representative: type: object allOf: – #/definitions/defaultDataOutput description: Dados do Representante itemComplement: type: string description: Complemento do item 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/listPrepareRenewalAgreement: post: description: Listar os resumos da renovação de contratos\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/queries/listPrepareRenewalAgreement – Processar\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – agreementIds – page properties: agreementIds: type: array items: type: string minimum: 1 description: Ids dos contratos que serão renovados page: type: object allOf: – #/definitions/page description: Paginação dos dados responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: contents: type: array items: type: object allOf: – #/definitions/prepareRenewalDataOutput description: Lista de contratos totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de vigências cadastradas 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade não encontrada default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/listAgreementReadjustmentWorkflow: post: description: Lista de itens de vigência que poderão ser reajustados no BPM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – branchId – processInstanceId properties: branchId: type: string description: Id da filial processInstanceId: type: integer format: int64 description: Id da instância do processo de aprovação responses: 200: description: Ok schema: type: object properties: contents: type: array items: type: object allOf: – #/definitions/agreementReadjustmentDataOutput description: Lista de itens de contratos que podem ser reajustados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista de itens de vigência que poderão ser reajustados no BPM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: branchId description: Id da filial in: query required: true type: string – name: processInstanceId description: Id da instância do processo de aprovação in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object properties: contents: type: array items: type: object allOf: – #/definitions/agreementReadjustmentDataOutput description: Lista de itens de contratos que podem ser reajustados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/queries/getDefinitionE099usuCtrGer: post: description: Retorna permissões de usuário para o módulo de contrato 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: – e099usuCtrGer properties: e099usuCtrGer: type: object allOf: – #/definitions/e099usuCtrGer description: Definição do usuário do finanças 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna permissões de usuário para o módulo de contrato 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: – e099usuCtrGer properties: e099usuCtrGer: type: object allOf: – #/definitions/e099usuCtrGer description: Definição do usuário do finanças 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/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 /foundation_agreement/queries/exportAgreementNumberControl: 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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/queries/exportE090pes: 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 /foundation_agreement/queries/exportE001end: 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 /foundation_agreement/queries/exportE066fpg: 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 /foundation_agreement/queries/exportE028cpg: 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 /foundation_agreement/queries/exportE083ori: 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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/queries/exportE015med: 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 /foundation_agreement/queries/exportE080ser: 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 /foundation_agreement/queries/exportE001tns: 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 /foundation_agreement/queries/exportE081tab: 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 /foundation_agreement/queries/exportE081tpr: 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 /foundation_agreement/queries/exportE081itp: 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 /foundation_agreement/queries/exportE091plf: 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 /foundation_agreement/queries/exportE044ccu: 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 /foundation_agreement/queries/exportE085pes: 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 /foundation_agreement/queries/exportE085hclComGer: 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 /foundation_agreement/queries/exportAgreementHeader: 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 /foundation_agreement/queries/exportAgreementTerm: 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 /foundation_agreement/queries/exportTermItem: 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 /foundation_agreement/queries/exportTermInstallment: 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 /foundation_agreement/queries/exportInstallmentItem: 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 /foundation_agreement/queries/exportInstallmentChargePayment: 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 /foundation_agreement/queries/exportInstallmentInvoice: 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 /foundation_agreement/queries/exportInstallmentInvoiceErrors: 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 /foundation_agreement/queries/exportInvoiceChargePayment: 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 /foundation_agreement/queries/exportE070filComGer: 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 /foundation_agreement/queries/exportE075ppc: 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 /foundation_agreement/queries/exportE080serComGer: 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 /foundation_agreement/queries/exportE012famComGer: 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 /foundation_agreement/queries/exportE001tnsCplImpSai: 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 /foundation_agreement/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 /foundation_agreement/queries/exportE009ppeComNfv: 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 /foundation_agreement/queries/exportE075derComGer: 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 /foundation_agreement/queries/exportE001tnsComNfs: 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 /foundation_agreement/queries/exportReadjustmentHistory: 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 /foundation_agreement/queries/exportRenewalHistory: 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 /foundation_agreement/queries/exportAgreementShareReport: 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 /foundation_agreement/queries/exportE070filCtrGer: 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 /foundation_agreement/queries/exportReadjustmentWorkflow: 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 /foundation_agreement/queries/exportE099usuCtrGer: 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 /foundation_agreement/queries/exportRehabilitationHistory: 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 /foundation_agreement/queries/exportE020snf: 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 /foundation_agreement/queries/exportE032edc: 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 /foundation_agreement/queries/exportE070filComNfs: 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 /foundation_agreement/queries/exportBillingHistory: 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 /foundation_agreement/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 /foundation_agreement/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/forceMigrateSchema: post: description: Executa o migrateSchema já removendo o tenant atual do cache da migração do schema do banco de dados, sem necessidade de reiniciar o serviço tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/resetSchema: post: description: Realiza a limpeza da base de dados, mantendo somente os dados padrões (conforme carga inicial) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/createAgreementHeader: post: description: Inserir o cabeçalho de um novo contrato\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/createAgreementHeader – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – branch – person – issueDate – recurrence – module – type properties: branch: type: object allOf: – #/definitions/branchDataInput description: Dados da filial person: type: object allOf: – #/definitions/personDataInput description: Dados da pessoa number: type: integer format: int64 description: Número (nos contratos de venda o número é gerado pelo sistema) description: type: string maxLength: 255 description: Descrição do contrato issueDate: type: string format: date-time description: Data de emissão recurrence: type: string allOf: – #/definitions/enumAgreementRecurrence description: Recorrência module: type: string allOf: – #/definitions/enumAgreementModule description: Módulo do contrato type: type: string allOf: – #/definitions/enumAgreementType description: Tipo do contrato invoiceAdditionalInformation: type: string description: Informações complementares para documento fiscal situationReason: type: string description: Motivo de situação específica do contrato serie: type: object allOf: – #/definitions/serieData description: Série para faturamento de contrato responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador do contrato 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/updateAgreementHeader: post: description: Atualizar o cabeçalho de um contrato\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/updateAgreementHeader – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – branch – person – issueDate – recurrence properties: id: type: string description: Identificador do cabeçalho do contrato branch: type: object allOf: – #/definitions/branchDataInput description: Dados da filial person: type: object allOf: – #/definitions/personDataInput description: Dados da pessoa number: type: integer format: int64 description: Número (nos contratos de venda o número é gerado pelo sistema) description: type: string maxLength: 255 description: Descrição issueDate: type: string format: date-time description: Data de emissão recurrence: type: string allOf: – #/definitions/enumAgreementRecurrence description: Recorrência invoiceAdditionalInformation: type: string description: Informações complementares para documento fiscal situationReason: type: string description: Motivo de situação específica do contrato serie: type: object allOf: – #/definitions/serieData description: Série para faturamento de contrato responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador do contrato 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/deleteAgreementHeader: post: description: Excluir o cabeçalho dos contratos\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/deleteAgreementHeader – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: array items: type: string minimum: 1 description: Lista com os identificadores dos contratos responses: 200: description: Ok schema: type: object required: – deletions properties: deletions: type: array items: type: object allOf: – #/definitions/agreementHeaderDeletion minimum: 1 description: Lista com o resultado das exclusões 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/createTermInstallment: post: description: Gerar as competências de uma vigência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/createTermInstallment – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – termId properties: termId: type: string description: Identificador da vigência installmentDate: type: string format: date description: Regerar as competências a partir desta data retroactiveTermInstallment: type: boolean description: Gerar competências de forma retroativa default: true responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/createAgreementTerm: post: description: Incluir uma vigência no contrato\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/createAgreementTerm – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – agreementId – startDate – dueDay – dueDateType – termType properties: agreementId: type: string description: Identificador do contrato startDate: type: string format: date description: Data inicial finalDate: type: string format: date description: Data final finishingDate: type: string format: date description: Data de encerramento da vigência dueDay: type: integer format: int64 description: Dia para vencimento minimum: 1 maximum: 31 billingAdvanceDays: type: integer format: int64 description: Quantidade de dias para antecipação da cobrança/pagamento minimum: 1 maximum: 999 dueDateType: type: string allOf: – #/definitions/enumDueDateType description: Tipo de vencimento invoiceAdditionalInformation: type: string description: Informações complementares para documento fiscal termType: type: string allOf: – #/definitions/enumTermType description: Tipo de prazo da vigência billingDay: type: integer format: int64 description: Dia base para faturamento minimum: 1 maximum: 31 responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador da vigência 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/updateAgreementTerm: post: description: Alterar uma vigência do contrato\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/updateAgreementTerm – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – dueDay properties: id: type: string description: Identificador da vigência dueDay: type: integer format: int64 description: Dia para vencimento minimum: 1 maximum: 31 billingAdvanceDays: type: integer format: int64 description: Quantidade de dias para antecipação da cobrança/pagamento minimum: 0 maximum: 999 billingDay: type: integer format: int64 description: Dia base para faturamento minimum: 1 maximum: 31 responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador da vigência 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/deleteAgreementTerm: post: description: Excluir as vigências do contrato\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/deleteAgreementTerm – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – agreementId – terms properties: agreementId: type: string description: Identificador do contrato terms: type: array items: type: string minimum: 1 description: Lista com os identificadores das vigências responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/finishAgreement: post: description: Encerramento dos contratos\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/finishAgreement – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: array items: type: string minimum: 1 description: Lista com os identificadores das vigências finishingReason: type: string description: Motivo de encerramento do contrato finishingNote: type: string description: Observação do encerramento do contrato responses: 200: description: Ok schema: type: object required: – closures properties: closures: type: array items: type: object allOf: – #/definitions/agreementFinishingRec minimum: 1 description: Lista com o resultado dos encerramentos 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/createTermItem: post: description: Incluir itens em uma vigência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/createTermItem – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – termId – items properties: termId: type: string description: Identificador da vigência items: type: array items: type: object allOf: – #/definitions/itemDataInput minimum: 1 description: Lista com os dados dos itens responses: 200: description: Ok schema: type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/itemDataCreateOutput minimum: 1 description: Lista com os dados dos itens 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/updateTermItem: post: description: Alterar um item de uma vigência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/updateTermItem – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – transaction – quantity – measureUnit – price properties: id: type: string description: Identificador do item itemProduct: type: object allOf: – #/definitions/productDataInput description: Dados do produto itemService: type: object allOf: – #/definitions/serviceDataInput description: Dados do serviço transaction: type: object allOf: – #/definitions/transactionDataInput description: Dados da transação quantity: type: number format: double description: Quantidade do item minimum: 0.0 maximum: 999999999.99999 measureUnit: type: object allOf: – #/definitions/measureUnitDataInput description: Dados da unidade de medida price: type: string description: Preço do item minimum: 0.0 maximum: 99999999999.9999999999 discountPercentage: type: number format: double description: Percentual de desconto minimum: 0.0 maximum: 999.99 priceList: type: object allOf: – #/definitions/priceListDataInput description: Dados da tabela de preço discountValue: type: string description: Valor de desconto minimum: 0.0 maximum: 9999999999999.99 financialAccount: type: object allOf: – #/definitions/financialAccountDataInput description: Dados da conta financeira costCenter: type: object allOf: – #/definitions/costCenterDataInput description: Dados do centro de custo representative: type: object allOf: – #/definitions/personDataInput description: Representante readjustmentIndex: type: object allOf: – #/definitions/indexDataInput description: Índice de reajuste readjustmentFrequency: type: integer format: int64 description: Periodicidade do reajuste maximum: 999 readjustmentDate: type: string format: date description: Data do próximo reajuste itemComplement: type: string description: Complemento do item responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador do item errors: type: array items: type: string description: Mensagens de erro que impedem a inclusão do item 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/deleteTermItem: post: description: Excluir os itens de uma vigência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/deleteTermItem – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – termId – items properties: termId: type: string description: Identificador da vigência items: type: array items: type: string minimum: 1 description: Lista com os identificadores dos itens responses: 200: description: Ok schema: type: object required: – deletions properties: deletions: type: array items: type: object allOf: – #/definitions/itemDeletion minimum: 1 description: Lista com o resultado das exclusões 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/updateTermInstallment: post: description: Alterar uma competência da vigência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/updateTermInstallment – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – dueDate properties: id: type: string description: Identificador da competência dueDate: type: string format: date description: Data de vencimento da competência paymentMethod: type: object allOf: – #/definitions/paymentMethodDataInput description: Dados da forma de pagamento invoiceAdditionalInformation: type: string description: Informações complementares para documento fiscal billingDate: type: string format: date description: Data base para faturamento da competência responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador da competência 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/createInstallmentItem: post: description: Incluir um item em uma competência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/createInstallmentItem – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – installmentId – item properties: installmentId: type: string description: Identificador da competência item: type: object allOf: – #/definitions/itemDataInput description: Lista com os dados dos itens responses: 200: description: Ok schema: type: object allOf: – #/definitions/itemDataOutput 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/updateInstallmentItem: post: description: Alterar um item de uma competência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/updateInstallmentItem – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – transaction – quantity – measureUnit – price properties: id: type: string description: Identificador do item itemProduct: type: object allOf: – #/definitions/productDataInput description: Dados do produto itemService: type: object allOf: – #/definitions/serviceDataInput description: Dados do serviço transaction: type: object allOf: – #/definitions/transactionDataInput description: Dados da transação quantity: type: number format: double description: Quantidade do item minimum: 0.0 maximum: 999999999.99999 measureUnit: type: object allOf: – #/definitions/measureUnitDataInput description: Dados da unidade de medida price: type: string description: Preço do item minimum: 0.0 maximum: 99999999999.9999999999 discountPercentage: type: number format: double description: Percentual de desconto minimum: 0.0 maximum: 999.99 priceList: type: object allOf: – #/definitions/priceListDataInput description: Dados da tabela de preço discountValue: type: string description: Valor de desconto minimum: 0.0 maximum: 9999999999999.99 financialAccount: type: object allOf: – #/definitions/financialAccountDataInput description: Dados da conta financeira costCenter: type: object allOf: – #/definitions/costCenterDataInput description: Dados do centro de custo representative: type: object allOf: – #/definitions/personDataInput description: Representante itemComplement: type: string description: Complemento do item responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador do item 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/deleteInstallmentItem: post: description: Excluir os itens de uma competência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/deleteInstallmentItem – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – installmentId – items properties: installmentId: type: string description: Identificador da competência items: type: array items: type: string minimum: 1 description: Lista com os identificadores dos itens responses: 200: description: Ok schema: type: object required: – deletions properties: deletions: type: array items: type: object allOf: – #/definitions/itemDeletion minimum: 1 description: Lista com o resultado das exclusões 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/updateAgreementClosure: post: description: Realiza o fechamento do contrato\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/updateAgreementClosure – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – ids properties: ids: type: array items: type: string minimum: 1 description: Identificador do contrato printAgreement: type: boolean description: Imprimir contrato default: false responses: 200: description: Ok schema: type: object required: – agreements properties: agreements: type: array items: type: object allOf: – #/definitions/agreementClosureDataOutput minimum: 1 description: Informações do contrato 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/cancelAgreement: post: description: Cancelar um contrato\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/cancelAgreement – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – reasonId properties: id: type: string description: Id do contrato a ser cancelado reasonId: type: string description: Id do motivo de cancelamento cancellingNote: type: string description: Observação do cancelamento responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Id do contrato cancelado 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/finishTerm: post: description: Encerrar uma vigência\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/finishTerm – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da vigência finishingReason: type: string description: Motivo do encerramento finishingNote: type: string description: Observação do encerramento responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Id da vigência lastActiveTerm: type: boolean description: Encerramento da última vigência 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/cancelTermInstallment: post: description: Efetuar o cancelamento de uma competência tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – termInstallmentId properties: termInstallmentId: type: string description: Id da competência cancellingReasonId: type: string description: Id do motivo do cancelamento cancellingNote: type: string description: Observação do cancelamento responses: 200: description: Ok schema: type: object properties: termInstallmentId: type: string description: Id da competência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/copyLastAgreementTerm: post: description: Efetuar cópia da última vigência do contrato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agreementHeader – startDate – finalDate properties: agreementHeader: type: string description: Id do contrato startDate: type: string format: date description: Data inicial da vigência finalDate: type: string format: date description: Data final da vigência responses: 200: description: Ok schema: type: object required: – agreementTermId properties: agreementTermId: type: string description: Id da vigência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/generateRenewalAgreement: post: description: Realiza a renovação do contrato de acordo com a última vigência\n### Resources:\n- res://senior.com.br/erpx_ctr/sale_agreement/queries/generateRenewalAgreement – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – agreements properties: agreements: type: array items: type: object allOf: – #/definitions/recRenewalAgreement minimum: 1 description: Dados do contrato responses: 200: description: Ok schema: type: object required: – agreementIds properties: agreementIds: type: array items: type: string minimum: 1 description: Ids do contratos 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade não encontrada default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/printAgreement: post: description: Imprimir relatório dos contratos\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/printAgreement – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – agreementIds properties: agreementIds: type: array items: type: string minimum: 1 description: Ids dos contratos sharingMethod: type: string allOf: – #/definitions/enumAgreementSharingMethod description: Tipo de geração relatório phoneNumber: type: string description: Número de telefone para compartilhamento por whatsapp email: type: string description: Email para compartilhamento responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/reprocessApportionment: post: description: Reprocessar o rateio para a vigência do contrato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agreementTermId properties: agreementTermId: type: string description: Id da vigência para reprocessar rateio responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/actions/rehabilitateAgreement: post: description: Reabilitação dos contratos\n### Resources:\n- res://senior.com.br/erpx_ctr/foundation_agreement/actions/rehabilitateAgreement – Processar\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – agreementIds properties: agreementIds: type: array items: type: string minimum: 1 description: Lista com os id dos contratos rehabilitationReasonId: type: string description: Motivo de reabilitação do contrato rehabilitationNote: type: string description: Observação da reabilitação responses: 200: description: Ok schema: type: object required: – agreementIds properties: agreementIds: type: array items: type: string minimum: 1 description: Ids do contratos que serão reabilitados 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /foundation_agreement/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 /foundation_agreement/actions/importAgreementNumberControl: 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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/actions/importE090pes: 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 /foundation_agreement/actions/importE001end: 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 /foundation_agreement/actions/importE066fpg: 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 /foundation_agreement/actions/importE028cpg: 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 /foundation_agreement/actions/importE083ori: 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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/actions/importE015med: 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 /foundation_agreement/actions/importE080ser: 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 /foundation_agreement/actions/importE001tns: 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 /foundation_agreement/actions/importE081tab: 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 /foundation_agreement/actions/importE081tpr: 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 /foundation_agreement/actions/importE081itp: 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 /foundation_agreement/actions/importE091plf: 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 /foundation_agreement/actions/importE044ccu: 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 /foundation_agreement/actions/importE085pes: 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 /foundation_agreement/actions/importE085hclComGer: 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 /foundation_agreement/actions/importAgreementHeader: 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 /foundation_agreement/actions/importAgreementTerm: 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 /foundation_agreement/actions/importTermItem: 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 /foundation_agreement/actions/importTermInstallment: 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 /foundation_agreement/actions/importInstallmentItem: 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 /foundation_agreement/actions/importInstallmentChargePayment: 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 /foundation_agreement/actions/importInstallmentInvoice: 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 /foundation_agreement/actions/importInstallmentInvoiceErrors: 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 /foundation_agreement/actions/importInvoiceChargePayment: 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 /foundation_agreement/actions/importE070filComGer: 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 /foundation_agreement/actions/importE075ppc: 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 /foundation_agreement/actions/importE080serComGer: 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 /foundation_agreement/actions/importE012famComGer: 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 /foundation_agreement/actions/importE001tnsCplImpSai: 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 /foundation_agreement/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 /foundation_agreement/actions/importE009ppeComNfv: 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 /foundation_agreement/actions/importE075derComGer: 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 /foundation_agreement/actions/importE001tnsComNfs: 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 /foundation_agreement/actions/importReadjustmentHistory: 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 /foundation_agreement/actions/importRenewalHistory: 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 /foundation_agreement/actions/importAgreementShareReport: 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 /foundation_agreement/actions/importE070filCtrGer: 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 /foundation_agreement/actions/importReadjustmentWorkflow: 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 /foundation_agreement/actions/importE099usuCtrGer: 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 /foundation_agreement/actions/importRehabilitationHistory: 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 /foundation_agreement/actions/importE020snf: 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 /foundation_agreement/actions/importE032edc: 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 /foundation_agreement/actions/importE070filComNfs: 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 /foundation_agreement/actions/importBillingHistory: 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 /foundation_agreement/signals/reprocessModuleApportionment: post: description: Reprocessar todos os rateios dos contratos tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /foundation_agreement/signals/calculateBalance: post: description: Signal de recálculo dos valores total e/ou aberto dos itens do contrato para requisição externa tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – balanceCalculation properties: balanceCalculation: type: object allOf: – #/definitions/recBalanceCalculation description: Payload para cálculo dos valores responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /foundation_agreement/events/createTermInstallmentSuccess: post: description: Evento de final de geração das competências x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – agreementTermId properties: termInstallmenIds: type: array items: type: string description: Lista de ids das competências geradas agreementTermId: type: string description: Id da vigência que foi realizada a geração das competência responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_agreement/events/readjustUpdateTermInstallmentsSuccess: post: description: Evento de final de atualização de competencias após reajuste x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: agreementTermId: type: string description: Id da vigência que teve suas competencias atualizadas responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_agreement/events/readjustGenerateTermInstallmentsSuccess: post: description: Evento de final de geração de competencias antes de reajustar x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: agreementTermId: type: string description: Id da vigência que teve suas competencias atualizadas responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_agreement/events/createTermInstallmentEvent: post: description: Evento para criar de forma assíncrona as parcelas x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – agreementTermId properties: agreementTermId: type: string description: Identificador do contrato installmentDate: type: string format: date description: Regerar as competências a partir desta data retroactiveTermInstallment: type: boolean description: Gerar competências de forma retroativa responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_agreement/events/processCreateTermInstallmentSuccessEvent: post: description: Evento para fechamento de forma assíncrona do contrato x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – agreementTermId properties: agreementTermId: type: string description: Identificador do contrato responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_agreement/events/renewalFromSaleAgreement: post: description: Evento de renovação dos contratos x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – totalAgreement – renewalAgreement – agreementIds properties: totalAgreement: type: integer format: int64 description: Total de contratos disponíveis para renovação renewalAgreement: type: integer format: int64 description: Total de contratos renovados agreementIds: type: array items: type: string minimum: 1 description: Ids do contrato que foram enviados para renovação responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_agreement/events/startRenewalAgreement: post: description: Iniciar renovação dos contratos x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – agreements properties: agreements: type: array items: type: object allOf: – #/definitions/recRenewalAgreement minimum: 1 description: Dados do contrato responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_agreement/events/agreementSharingReportReady: post: description: Evento para compartilhamento do relatório do contrato x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – sharingUrl – agreementId properties: sharingUrl: type: string description: URL de compartilhamento agreementId: type: string description: Id do contrato responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_agreement/events/agreementRehabilitationError: post: description: Evento de erro na reabilitação x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: agreementId: type: string description: Identificador do contrato errorMessage: type: string description: Mensagem de erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_agreement/events/agreementApportionmentRehabilitation: post: description: Evento de reabilitação do rateio x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: agreementId: type: string description: Identificador do contrato responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_agreement/events/balanceCalculationEvent: post: description: Evento de recálculo dos valores total e/ou aberto dos itens do contrato x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – balanceCalculation properties: balanceCalculation: type: object allOf: – #/definitions/recBalanceCalculation description: Payload para cálculo dos valores responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_agreement/events/batchTermItemUpdated: post: description: Evento de atualização dos itens da vigência x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – termItems properties: termItems: type: array items: type: object allOf: – #/definitions/itemDataOutput minimum: 1 description: Lista de itens da vigência responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_agreement/events/startAgreementRehabilitation: post: description: Evento de inicio assíncrono da reabilitação x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – agreementIds properties: agreementIds: type: array items: type: string minimum: 1 description: Lista com os id dos contratos rehabilitationReasonId: type: string description: Motivo de reabilitação do contrato rehabilitationNote: type: string description: Observação da reabilitação responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_agreement/events/agreementHeaderChanged: post: description: Evento de contrato atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: agreementHeader: type: object allOf: – #/definitions/agreementHeaderOutput description: Contrato responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_agreement/events/importAgreementNumberControlEvent: 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 /foundation_agreement/events/exportAgreementNumberControlEvent: 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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/events/importE090pesEvent: 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 /foundation_agreement/events/exportE090pesEvent: 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 /foundation_agreement/events/importE001endEvent: 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 /foundation_agreement/events/exportE001endEvent: 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 /foundation_agreement/events/importE066fpgEvent: 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 /foundation_agreement/events/exportE066fpgEvent: 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 /foundation_agreement/events/importE028cpgEvent: 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 /foundation_agreement/events/exportE028cpgEvent: 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 /foundation_agreement/events/importE083oriEvent: 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 /foundation_agreement/events/exportE083oriEvent: 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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/events/importE015medEvent: 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 /foundation_agreement/events/exportE015medEvent: 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 /foundation_agreement/events/importE080serEvent: 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 /foundation_agreement/events/exportE080serEvent: 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 /foundation_agreement/events/importE001tnsEvent: 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 /foundation_agreement/events/exportE001tnsEvent: 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 /foundation_agreement/events/importE081tabEvent: 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 /foundation_agreement/events/exportE081tabEvent: 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 /foundation_agreement/events/importE081tprEvent: 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 /foundation_agreement/events/exportE081tprEvent: 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 /foundation_agreement/events/importE081itpEvent: 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 /foundation_agreement/events/exportE081itpEvent: 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 /foundation_agreement/events/importE091plfEvent: 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 /foundation_agreement/events/exportE091plfEvent: 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 /foundation_agreement/events/importE044ccuEvent: 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 /foundation_agreement/events/exportE044ccuEvent: 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 /foundation_agreement/events/importE085pesEvent: 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 /foundation_agreement/events/exportE085pesEvent: 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 /foundation_agreement/events/importE085hclComGerEvent: 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 /foundation_agreement/events/exportE085hclComGerEvent: 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 /foundation_agreement/events/importAgreementHeaderEvent: 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 /foundation_agreement/events/exportAgreementHeaderEvent: 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 /foundation_agreement/events/importAgreementTermEvent: 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 /foundation_agreement/events/exportAgreementTermEvent: 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 /foundation_agreement/events/importTermItemEvent: 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 /foundation_agreement/events/exportTermItemEvent: 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 /foundation_agreement/events/importTermInstallmentEvent: 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 /foundation_agreement/events/exportTermInstallmentEvent: 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 /foundation_agreement/events/importInstallmentItemEvent: 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 /foundation_agreement/events/exportInstallmentItemEvent: 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 /foundation_agreement/events/importInstallmentChargePaymentEvent: 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 /foundation_agreement/events/exportInstallmentChargePaymentEvent: 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 /foundation_agreement/events/importInstallmentInvoiceEvent: 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 /foundation_agreement/events/exportInstallmentInvoiceEvent: 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 /foundation_agreement/events/importInstallmentInvoiceErrorsEvent: 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 /foundation_agreement/events/exportInstallmentInvoiceErrorsEvent: 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 /foundation_agreement/events/importInvoiceChargePaymentEvent: 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 /foundation_agreement/events/exportInvoiceChargePaymentEvent: 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 /foundation_agreement/events/importE070filComGerEvent: 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 /foundation_agreement/events/exportE070filComGerEvent: 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 /foundation_agreement/events/importE075ppcEvent: 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 /foundation_agreement/events/exportE075ppcEvent: 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 /foundation_agreement/events/importE080serComGerEvent: 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 /foundation_agreement/events/exportE080serComGerEvent: 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 /foundation_agreement/events/importE012famComGerEvent: 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 /foundation_agreement/events/exportE012famComGerEvent: 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 /foundation_agreement/events/importE001tnsCplImpSaiEvent: 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 /foundation_agreement/events/exportE001tnsCplImpSaiEvent: 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 /foundation_agreement/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 /foundation_agreement/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 /foundation_agreement/events/importE009ppeComNfvEvent: 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 /foundation_agreement/events/exportE009ppeComNfvEvent: 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 /foundation_agreement/events/importE075derComGerEvent: 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 /foundation_agreement/events/exportE075derComGerEvent: 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 /foundation_agreement/events/importE001tnsComNfsEvent: 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 /foundation_agreement/events/exportE001tnsComNfsEvent: 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 /foundation_agreement/events/importReadjustmentHistoryEvent: 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 /foundation_agreement/events/exportReadjustmentHistoryEvent: 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 /foundation_agreement/events/importRenewalHistoryEvent: 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 /foundation_agreement/events/exportRenewalHistoryEvent: 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 /foundation_agreement/events/importAgreementShareReportEvent: 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 /foundation_agreement/events/exportAgreementShareReportEvent: 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 /foundation_agreement/events/importE070filCtrGerEvent: 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 /foundation_agreement/events/exportE070filCtrGerEvent: 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 /foundation_agreement/events/importReadjustmentWorkflowEvent: 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 /foundation_agreement/events/exportReadjustmentWorkflowEvent: 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 /foundation_agreement/events/importE099usuCtrGerEvent: 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 /foundation_agreement/events/exportE099usuCtrGerEvent: 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 /foundation_agreement/events/importRehabilitationHistoryEvent: 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 /foundation_agreement/events/exportRehabilitationHistoryEvent: 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 /foundation_agreement/events/importE020snfEvent: 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 /foundation_agreement/events/exportE020snfEvent: 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 /foundation_agreement/events/importE032edcEvent: 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 /foundation_agreement/events/exportE032edcEvent: 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 /foundation_agreement/events/importE070filComNfsEvent: 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 /foundation_agreement/events/exportE070filComNfsEvent: 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 /foundation_agreement/events/importBillingHistoryEvent: 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 /foundation_agreement/events/exportBillingHistoryEvent: 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 /foundation_agreement/entities/agreementNumberControl: 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/agreementNumberControl responses: 200: description: The created resource schema: #/definitions/agreementNumberControl 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/agreementNumberControl responses: 200: description: The created resource schema: #/definitions/agreementNumberControl 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: array items: #/definitions/agreementNumberControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/agreementNumberControl/{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/agreementNumberControl responses: 200: description: Ok schema: #/definitions/agreementNumberControl 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/agreementNumberControl responses: 200: description: Ok schema: #/definitions/agreementNumberControl 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/agreementNumberControl 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 /foundation_agreement/entities/agreementNumberControl/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/agreementNumberControl responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/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: array items: #/definitions/e031moe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/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 /foundation_agreement/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: array items: #/definitions/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/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 /foundation_agreement/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: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/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 /foundation_agreement/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: array items: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/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 /foundation_agreement/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: array items: #/definitions/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/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 /foundation_agreement/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: array items: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/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 /foundation_agreement/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: array items: #/definitions/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/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 /foundation_agreement/entities/e090pes: 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: array items: #/definitions/e090pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e090pes/{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/e090pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e001end: 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: array items: #/definitions/e001end 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e001end/{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/e001end 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e066fpg: 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: array items: #/definitions/e066fpg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e066fpg/{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/e066fpg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e028cpg: 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: array items: #/definitions/e028cpg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e028cpg/{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/e028cpg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e083ori: 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: array items: #/definitions/e083ori 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e083ori/{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/e083ori 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/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: array items: #/definitions/e012fam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/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 /foundation_agreement/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: array items: #/definitions/e075der 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/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 /foundation_agreement/entities/e015med: 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: array items: #/definitions/e015med 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e015med/{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/e015med 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e080ser: 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: array items: #/definitions/e080ser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e080ser/{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/e080ser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e001tns: 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: array items: #/definitions/e001tns 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e001tns/{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/e001tns 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e081tab: 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: array items: #/definitions/e081tab 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e081tab/{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/e081tab 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e081tpr: 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: array items: #/definitions/e081tpr 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e081tpr/{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/e081tpr 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e081itp: 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: array items: #/definitions/e081itp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e081itp/{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/e081itp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e091plf: 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: array items: #/definitions/e091plf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e091plf/{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/e091plf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e044ccu: 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: array items: #/definitions/e044ccu 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e044ccu/{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/e044ccu 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e085pes: 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: array items: #/definitions/e085pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e085pes/{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/e085pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e085hclComGer: 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: array items: #/definitions/e085hclComGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e085hclComGer/{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/e085hclComGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/agreementHeader/{parentId}/agreementTerm: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/agreementTerm responses: 200: description: The created resources schema: type: array items: #/definitions/agreementTerm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/agreementTerm responses: 200: description: The created resources schema: type: array items: #/definitions/agreementTerm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/agreementTerm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/agreementHeader/{parentId}/agreementTerm/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/agreementTerm responses: 200: description: Ok schema: #/definitions/agreementTerm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/agreementTerm responses: 200: description: Ok schema: #/definitions/agreementTerm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/agreementTerm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/agreementTerm/{parentId}/termItem: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/termItem responses: 200: description: The created resources schema: type: array items: #/definitions/termItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/termItem responses: 200: description: The created resources schema: type: array items: #/definitions/termItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/termItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/agreementTerm/{parentId}/termItem/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/termItem responses: 200: description: Ok schema: #/definitions/termItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/termItem responses: 200: description: Ok schema: #/definitions/termItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/termItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/agreementTerm/{parentId}/termInstallment: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/termInstallment responses: 200: description: The created resources schema: type: array items: #/definitions/termInstallment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/termInstallment responses: 200: description: The created resources schema: type: array items: #/definitions/termInstallment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/termInstallment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/agreementTerm/{parentId}/termInstallment/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/termInstallment responses: 200: description: Ok schema: #/definitions/termInstallment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/termInstallment responses: 200: description: Ok schema: #/definitions/termInstallment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/termInstallment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/termInstallment/{parentId}/installmentItem: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/installmentItem responses: 200: description: The created resources schema: type: array items: #/definitions/installmentItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/installmentItem responses: 200: description: The created resources schema: type: array items: #/definitions/installmentItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/installmentItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/termInstallment/{parentId}/installmentItem/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/installmentItem responses: 200: description: Ok schema: #/definitions/installmentItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/installmentItem responses: 200: description: Ok schema: #/definitions/installmentItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/installmentItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/installmentChargePayment: 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/installmentChargePayment responses: 200: description: The created resource schema: #/definitions/installmentChargePayment 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/installmentChargePayment responses: 200: description: The created resource schema: #/definitions/installmentChargePayment 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: array items: #/definitions/installmentChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/installmentChargePayment/{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/installmentChargePayment responses: 200: description: Ok schema: #/definitions/installmentChargePayment 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/installmentChargePayment responses: 200: description: Ok schema: #/definitions/installmentChargePayment 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/installmentChargePayment 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 /foundation_agreement/entities/termInstallment/{parentId}/installmentChargePayment: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/installmentChargePayment responses: 200: description: The created resources schema: type: array items: #/definitions/installmentChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/installmentChargePayment responses: 200: description: The created resources schema: type: array items: #/definitions/installmentChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/installmentChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/termInstallment/{parentId}/installmentChargePayment/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/installmentChargePayment responses: 200: description: Ok schema: #/definitions/installmentChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/installmentChargePayment responses: 200: description: Ok schema: #/definitions/installmentChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/installmentChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/installmentChargePayment/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/installmentChargePayment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/termInstallment/{parentId}/installmentInvoice: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/installmentInvoice responses: 200: description: The created resources schema: type: array items: #/definitions/installmentInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/installmentInvoice responses: 200: description: The created resources schema: type: array items: #/definitions/installmentInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/installmentInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/termInstallment/{parentId}/installmentInvoice/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/installmentInvoice responses: 200: description: Ok schema: #/definitions/installmentInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/installmentInvoice responses: 200: description: Ok schema: #/definitions/installmentInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/installmentInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/installmentInvoiceErrors: 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/installmentInvoiceErrors responses: 200: description: The created resource schema: #/definitions/installmentInvoiceErrors 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/installmentInvoiceErrors responses: 200: description: The created resource schema: #/definitions/installmentInvoiceErrors 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: array items: #/definitions/installmentInvoiceErrors 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/installmentInvoiceErrors/{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/installmentInvoiceErrors responses: 200: description: Ok schema: #/definitions/installmentInvoiceErrors 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/installmentInvoiceErrors responses: 200: description: Ok schema: #/definitions/installmentInvoiceErrors 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/installmentInvoiceErrors 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 /foundation_agreement/entities/installmentInvoice/{parentId}/installmentInvoiceErrors: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/installmentInvoiceErrors responses: 200: description: The created resources schema: type: array items: #/definitions/installmentInvoiceErrors 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/installmentInvoiceErrors responses: 200: description: The created resources schema: type: array items: #/definitions/installmentInvoiceErrors 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/installmentInvoiceErrors 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/installmentInvoice/{parentId}/installmentInvoiceErrors/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/installmentInvoiceErrors responses: 200: description: Ok schema: #/definitions/installmentInvoiceErrors 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/installmentInvoiceErrors responses: 200: description: Ok schema: #/definitions/installmentInvoiceErrors 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/installmentInvoiceErrors 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/installmentInvoiceErrors/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/installmentInvoiceErrors responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/installmentChargePayment/{parentId}/invoiceChargePayment: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/invoiceChargePayment responses: 200: description: The created resources schema: type: array items: #/definitions/invoiceChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/invoiceChargePayment responses: 200: description: The created resources schema: type: array items: #/definitions/invoiceChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/invoiceChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/installmentInvoice/{parentId}/invoiceChargePayment: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/invoiceChargePayment responses: 200: description: The created resources schema: type: array items: #/definitions/invoiceChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/invoiceChargePayment responses: 200: description: The created resources schema: type: array items: #/definitions/invoiceChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/invoiceChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/installmentChargePayment/{parentId}/invoiceChargePayment/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/invoiceChargePayment responses: 200: description: Ok schema: #/definitions/invoiceChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/invoiceChargePayment responses: 200: description: Ok schema: #/definitions/invoiceChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/invoiceChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/installmentInvoice/{parentId}/invoiceChargePayment/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/invoiceChargePayment responses: 200: description: Ok schema: #/definitions/invoiceChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/invoiceChargePayment responses: 200: description: Ok schema: #/definitions/invoiceChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/invoiceChargePayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e021mot: 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/e021mot responses: 200: description: The created resource schema: #/definitions/e021mot 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/e021mot responses: 200: description: The created resource schema: #/definitions/e021mot 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: array items: #/definitions/e021mot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e021mot/{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/e021mot responses: 200: description: Ok schema: #/definitions/e021mot 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/e021mot responses: 200: description: Ok schema: #/definitions/e021mot 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/e021mot 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 /foundation_agreement/entities/e021mot/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e021mot responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e009ppeComNfv: 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: array items: #/definitions/e009ppeComNfv 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e009ppeComNfv/{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/e009ppeComNfv 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e075derComGer: 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: array items: #/definitions/e075derComGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e075derComGer/{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/e075derComGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e001tnsComNfs: 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/e001tnsComNfs responses: 200: description: The created resource schema: #/definitions/e001tnsComNfs 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/e001tnsComNfs responses: 200: description: The created resource schema: #/definitions/e001tnsComNfs 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: array items: #/definitions/e001tnsComNfs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e001tnsComNfs/{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/e001tnsComNfs responses: 200: description: Ok schema: #/definitions/e001tnsComNfs 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/e001tnsComNfs responses: 200: description: Ok schema: #/definitions/e001tnsComNfs 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/e001tnsComNfs 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 /foundation_agreement/entities/e001tnsComNfs/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e001tnsComNfs responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/readjustmentHistory: 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/readjustmentHistory responses: 200: description: The created resource schema: #/definitions/readjustmentHistory 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/readjustmentHistory responses: 200: description: The created resource schema: #/definitions/readjustmentHistory 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: array items: #/definitions/readjustmentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/readjustmentHistory/{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/readjustmentHistory responses: 200: description: Ok schema: #/definitions/readjustmentHistory 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/readjustmentHistory responses: 200: description: Ok schema: #/definitions/readjustmentHistory 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/readjustmentHistory 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 /foundation_agreement/entities/agreementHeader/{parentId}/readjustmentHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/readjustmentHistory responses: 200: description: The created resources schema: type: array items: #/definitions/readjustmentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/readjustmentHistory responses: 200: description: The created resources schema: type: array items: #/definitions/readjustmentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/readjustmentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/agreementHeader/{parentId}/readjustmentHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/readjustmentHistory responses: 200: description: Ok schema: #/definitions/readjustmentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/readjustmentHistory responses: 200: description: Ok schema: #/definitions/readjustmentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/readjustmentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/readjustmentHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/readjustmentHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/renewalHistory: 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/renewalHistory responses: 200: description: The created resource schema: #/definitions/renewalHistory 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/renewalHistory responses: 200: description: The created resource schema: #/definitions/renewalHistory 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: array items: #/definitions/renewalHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/renewalHistory/{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/renewalHistory responses: 200: description: Ok schema: #/definitions/renewalHistory 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/renewalHistory responses: 200: description: Ok schema: #/definitions/renewalHistory 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/renewalHistory 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 /foundation_agreement/entities/agreementHeader/{parentId}/renewalHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/renewalHistory responses: 200: description: The created resources schema: type: array items: #/definitions/renewalHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/renewalHistory responses: 200: description: The created resources schema: type: array items: #/definitions/renewalHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/renewalHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/agreementHeader/{parentId}/renewalHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/renewalHistory responses: 200: description: Ok schema: #/definitions/renewalHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/renewalHistory responses: 200: description: Ok schema: #/definitions/renewalHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/renewalHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/renewalHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/renewalHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/agreementShareReport: 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/agreementShareReport responses: 200: description: The created resource schema: #/definitions/agreementShareReport 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/agreementShareReport responses: 200: description: The created resource schema: #/definitions/agreementShareReport 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: array items: #/definitions/agreementShareReport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/agreementShareReport/{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/agreementShareReport responses: 200: description: Ok schema: #/definitions/agreementShareReport 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/agreementShareReport responses: 200: description: Ok schema: #/definitions/agreementShareReport 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/agreementShareReport 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 /foundation_agreement/entities/agreementShareReport/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/agreementShareReport responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e070filCtrGer: 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: array items: #/definitions/e070filCtrGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e070filCtrGer/{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/e070filCtrGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/readjustmentWorkflow: 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/readjustmentWorkflow responses: 200: description: The created resource schema: #/definitions/readjustmentWorkflow 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/readjustmentWorkflow responses: 200: description: The created resource schema: #/definitions/readjustmentWorkflow 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: array items: #/definitions/readjustmentWorkflow 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/readjustmentWorkflow/{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/readjustmentWorkflow responses: 200: description: Ok schema: #/definitions/readjustmentWorkflow 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/readjustmentWorkflow responses: 200: description: Ok schema: #/definitions/readjustmentWorkflow 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/readjustmentWorkflow 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 /foundation_agreement/entities/readjustmentWorkflow/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/readjustmentWorkflow responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e099usuCtrGer: 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/e099usuCtrGer responses: 200: description: The created resource schema: #/definitions/e099usuCtrGer 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/e099usuCtrGer responses: 200: description: The created resource schema: #/definitions/e099usuCtrGer 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: array items: #/definitions/e099usuCtrGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e099usuCtrGer/{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/e099usuCtrGer responses: 200: description: Ok schema: #/definitions/e099usuCtrGer 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/e099usuCtrGer responses: 200: description: Ok schema: #/definitions/e099usuCtrGer 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/e099usuCtrGer 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 /foundation_agreement/entities/e099usuCtrGer/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e099usuCtrGer responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/rehabilitationHistory: 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/rehabilitationHistory responses: 200: description: The created resource schema: #/definitions/rehabilitationHistory 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/rehabilitationHistory responses: 200: description: The created resource schema: #/definitions/rehabilitationHistory 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: array items: #/definitions/rehabilitationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/rehabilitationHistory/{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/rehabilitationHistory responses: 200: description: Ok schema: #/definitions/rehabilitationHistory 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/rehabilitationHistory responses: 200: description: Ok schema: #/definitions/rehabilitationHistory 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/rehabilitationHistory 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 /foundation_agreement/entities/agreementHeader/{parentId}/rehabilitationHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/rehabilitationHistory responses: 200: description: The created resources schema: type: array items: #/definitions/rehabilitationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/rehabilitationHistory responses: 200: description: The created resources schema: type: array items: #/definitions/rehabilitationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/rehabilitationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/agreementHeader/{parentId}/rehabilitationHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/rehabilitationHistory responses: 200: description: Ok schema: #/definitions/rehabilitationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/rehabilitationHistory responses: 200: description: Ok schema: #/definitions/rehabilitationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/rehabilitationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/rehabilitationHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/rehabilitationHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e020snf: 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: array items: #/definitions/e020snf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e020snf/{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/e020snf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e032edc: 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: array items: #/definitions/e032edc 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e032edc/{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/e032edc 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e070filComNfs: 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: array items: #/definitions/e070filComNfs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/e070filComNfs/{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/e070filComNfs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/termInstallment/{parentId}/billingHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/billingHistory responses: 200: description: The created resources schema: type: array items: #/definitions/billingHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/billingHistory responses: 200: description: The created resources schema: type: array items: #/definitions/billingHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/billingHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_agreement/entities/termInstallment/{parentId}/billingHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/billingHistory responses: 200: description: Ok schema: #/definitions/billingHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/billingHistory responses: 200: description: Ok schema: #/definitions/billingHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/billingHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: description: Up or down type: string enum: – UP – DOWN enumTipEmp: description: Tipo de empresa type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V99 enumJurFis: description: Tipo Pessoa type: string enum: – VJ – VF enumSitReg: description: Situação registro type: string enum: – VA – VI enumTipFpg: description: Tipo pagamento type: string enum: – V01 – V02 – V03 – V04 – V05 – V10 – V11 – V12 – V13 – V15 – V16 – V17 – V18 – V19 – V90 – V99 enumAplCpg: description: Enumeração de aplicação da condição de pagamento type: string enum: – VV – VC – VA enumDiaEsp: description: Enumeração de dia especial type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – VA – VS – VD – VQ – VM enumAntPos: description: Critério Dia Vencimento type: string enum: – VA – VS – VN – VU enumTipPar: description: Enumeração do tipo de parcela type: string enum: – V1 – V2 – V3 enumTipPro: description: Tipo produto type: string enum: – VP – VC – VM – VD – VS enumLisMod: description: Módulo da transação type: string enum: – VVEP – VVEO – VVEC – VVEF – VVES – VVEN – VESN – VESR – VESB – VESC – VESF – VCRE – VCRP – VCRB – VCRA – VRAM – VCRV – VCOO – VCSO – VCOF – VCOS – VCON – VCPE – VCPP – VCPB – VCPM – VCPA – VPAM – VCPV – VCBC – VCBM – VFTC – VPCP – VCFB – VPAT – VPRJ – VCCR – VCCP enumProSer: description: Enumeração de Produto Serviço type: string enum: – VP – VS enumAgreementModule: description: Módulo do contrato type: string enum: – SALE – PURCHASE – FINANCIAL enumAgreementType: description: Tipo do contrato type: string enum: – PURCHASE_PRODUCT – PURCHASE_SERVICE – PURCHASE_LEASING – SALE_PRODUCT – SALE_SERVICE – SALE_LEASING – FINANCIAL_APPLICATION – FINANCIAL_LOAN – FINANCIAL_INVESTMENT_FUND – FINANCIAL_FORWARD_MARKET – FINANCIAL_FUTURE_MARKET – FINANCIAL_OPTIONS_MARKET – FINANCIAL_NDF_MARKET – FINANCIAL_SWAP_MARKET enumAgreementRecurrence: description: Recorrência do contrato type: string enum: – MONTHLY – BIMONTHLY – QUARTERLY – FOUR_MONTHLY – BIANNUAL – ANNUAL enumDueDateType: description: Tipo de vencimento type: string enum: – CURRENT_MONTH – NEXT_MONTH enumAgreementStatus: description: Situação do contrato type: string enum: – TYPING – CLOSED – CANCELED – FINISHED – SUSPENDED – PROCESSING_REHABILITATION enumAgreementBillingType: description: Forma de geração da cobrança do contrato type: string enum: – BY_AGREEMENT – BY_INVOICING enumAgreementTermStatus: description: Situações da vigência type: string enum: – ACTIVE – FINISHED – CANCELED – FORESEEN – GENERATING_INSTALLMENTS – GENERATING_READJUSTMENT – ERROR_GENERATING_INSTALLMENTS – IN_EXCLUSION enumChargePaymentType: description: Tipo (Cobrança ou Pagamento) type: string enum: – CHARGE – PAYMENT enumChargePaymentStatus: description: Situação da cobrança/pagamento type: string enum: – WAITING – PAID – NOT_CREATED – NO_CHARGE – CANCELED enumInvoiceType: description: Tipo da nota fiscal type: string enum: – SALE – PURCHASE enumInvoiceStatus: description: Situação da nota fiscal type: string enum: – ERROR – NOT_CREATED – TYPING – DISABLED – CANCELED – ISSUED – PROCESSING enumInstallmentStatus: description: Situação da competência type: string enum: – OPENED – PROCESSING – NOT_BILLED – CANCELED – BILLED enumAplNop: description: Aplicações da natureza de operação da transação type: string enum: – VN – VS – VI – VR – VO – VT – VD – VA – VB – VE – VC – VF – VG – VV – VX enumAplMot: description: Aplicações Motivo 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 enumTermType: description: Prazo da vigência type: string enum: – DETERMINED_PERIOD – UNDETERMINED_PERIOD enumTypeOrder: description: Tipo de ordenação type: string enum: – Asc – Desc enumAdjFrm: description: Formulário para correção validação type: string enum: – NONE – CADASTRO_SERIE – CADASTRO_CIDADE – CADASTRO_FILIAL – CADASTRO_PESSOA – CADASTRO_TRANSACAO – CADASTRO_PRODUTO – CADASTRO_TRANSPORTADOR – CADASTRO_SERVICO – CADASTRO_FORMA_DE_PAGAMENTO – CADASTRO_PERFIL_TRIBUTARIO – CADASTRO_DEFINICOES_FILIAL_COBRANCA – CADASTRO_DEFINICOES_FILIAL_ADICIONAIS – CADASTRO_DEFINICOES_FILIAL_TRANSPORTE – CADASTRO_DEFINICOES_FILIAL_REPRESENTANTE – CADASTRO_UNIDADE_MEDIDA – STEP_ITENS – CADASTRO_NCM – STEP_ADICIONAIS – STEP_COBRANCA – STEP_TRANSPORTE – CADASTRO_USUARIO – CADASTRO_MOTIVO – CADASTRO_PARAMETROS_ESTADO – CADASTRO_FAMILIA – CADASTRO_TABELA_PRECO – CADASTRO_MENSAGEM_FISCAL – CADASTRO_FINALIDADE_VENDA – CADASTRO_ENDERECO_FILIAL – CADASTRO_ENDERECO_CLIENTE – CADASTRO_TRANSPORTADORA enumOpeVen: description: Tipo da operação de venda type: string enum: – VC – VR – VN enumAgreementSharingMethod: description: Tipo de compartilhamento do relatório type: string enum: – PRINT – WHATSAPP – EMAIL enumApportionmentStatus: description: Situação do rateio type: string enum: – UNPROCESSED – PROCESSING – PROCESSED – ERROR enumRehabilitationHistoryStatus: description: Status da reabilitação type: string enum: – STARTED – ERROR – SUCCESS enumBalanceType: description: Tipo de valor a recalcular type: string enum: – BOTH – AVAILABLE – TOTAL enumDisAut: description: Dispositivo autorizado type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 enumAplSnf: description: Situação registro type: string enum: – VS – VM – VE – VF – VD enumFinSnf: description: Finalidade type: string enum: – EMISSAO_PROPRIA – EMISSAO_TERCEIRO userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recRenewalAgreement: description: Dados do contrato type: object required: – id – startDate – finalDate properties: id: type: string description: Id do contrato startDate: type: string format: date description: Data inicial da nova vigência finalDate: type: string format: date description: Data inicial da nova vigência branchDataInput: description: Dados da filial para input type: object properties: id: type: string description: Identificador documentNumber: type: string maxLength: 14 description: Número do CNPJ ou CPF personDataInput: description: Dados da pessoa para input type: object properties: id: type: string description: Identificador code: type: integer format: int64 description: Código minimum: 0 maximum: 999999999 documentNumber: type: string maxLength: 14 description: Número do CNPJ ou CPF companyDataInput: description: Dados da empresa para input type: object properties: id: type: string description: Identificador code: type: integer format: int64 description: Código minimum: 0 maximum: 9999 installmentChargePaymentOutput: description: Dados da cobrança da competência para output type: object properties: id: type: string description: Id da cobrança/pagamento da competência chargePaymentType: type: string allOf: – #/definitions/enumChargePaymentType description: Tipo da cobrança/pagamento status: type: string allOf: – #/definitions/enumChargePaymentStatus description: Situação dueDate: type: string format: date description: Data de vencimento chargePayment: type: object allOf: – #/definitions/chargePaymentOutput description: Dados da cobrança branch: type: object allOf: – #/definitions/personDataOutput description: Dados da filial agreementHeaderOutput: description: Dados do cabeçalho do contrato para output type: object required: – id properties: id: type: string description: Identificador company: type: object allOf: – #/definitions/companyDataOutput description: Dados da empresa branch: type: object allOf: – #/definitions/personDataOutput description: Dados da filial person: type: object allOf: – #/definitions/personDataOutput description: Dados da pessoa module: type: string allOf: – #/definitions/enumAgreementModule description: Módulo do contrato type: type: string allOf: – #/definitions/enumAgreementType description: Tipo do contrato number: type: integer format: int64 description: Número do contrato description: type: string description: Descrição do contrato issueDate: type: string format: date-time description: Data de emissão recurrence: type: string allOf: – #/definitions/enumAgreementRecurrence description: Recorrência status: type: string allOf: – #/definitions/enumAgreementStatus description: Situação cancellingReason: type: object allOf: – #/definitions/defaultDataOutput description: Dados do motivo do cancelamento do contrato finishingDate: type: string format: date description: Data de encerramento do contrato cancellingDate: type: string format: date description: Data de cancelamento do contrato currentTerm: type: string description: Vigência atual do contrato invoiceAdditionalInformation: type: string description: Informações complementares para documento fiscal situationReason: type: object allOf: – #/definitions/defaultDataOutput description: Motivo de situação específica do contrato finishingReason: type: object allOf: – #/definitions/defaultDataOutput description: Motivo de encerramento do contrato agreementExpired: type: boolean description: Contrato vencido hasUndeterminedTerm: type: boolean description: Tem vigência indeterminada createdBy: type: string description: Usuário responsável pela geração do contrato creationDateTime: type: string format: date-time description: Data e hora de geração do contrato updatedBy: type: string description: Usuário responsável pela alteração do contrato updateDateTime: type: string format: date-time description: Data e hora de alteração do contrato serie: type: object allOf: – #/definitions/serieData description: Série para faturamento de contrato finishingNote: type: string description: Observação de encerramento do contrato cancellingNote: type: string description: Observação de cancelamento do contrato installmentInvoiceOutput: description: Nota fiscal da competência type: object properties: id: type: string description: Identificador único da nota fiscal da competência type: type: string description: Tipo da nota fiscal (Entrada ou Saída) invoiceId: type: string description: Identificador único da nota fiscal invoiceNumber: type: string description: Número da nota fiscal serieCode: type: string description: Códito da série netValue: type: string description: Valor líquido da nota fiscal status: type: string description: Situação da nota fiscal da competência agreementId: type: string description: Id do contrato dueDate: type: string format: date description: Data de vencimento da competência branch: type: object allOf: – #/definitions/companyDataOutput description: Dados da filial da cobrança da competência validationMessage: type: string description: Mensagem de validação da nota da competência adjustments: type: array items: type: object allOf: – #/definitions/adjustment description: Lista de ajustes companyDataOutput: description: Dados da empresa para output discriminator: _discriminator type: object required: – id – _discriminator properties: id: type: string description: Identificador code: type: integer format: int64 description: Código tradeName: type: string description: Nome fantasia _discriminator: type: string description: chargePaymentOutput: description: Dados da cobrança para output type: object properties: id: type: string description: Id do titulo de cobrança/pagamento number: type: string description: Número do título de cobrança/pagamento code: type: string description: Código do tipo do título value: type: string description: Valor da cobrança personDataOutput: description: Dados da pessoa para output allOf: – #/definitions/companyDataOutput – type: object properties: documentNumber: type: string description: Número do CNPJ/CPF phoneNumber: type: string description: Número de telefone secondPhoneNumber: type: string description: Número de telefone 2 email: type: string description: Email page: description: Dados da paginação type: object required: – offset – size properties: offset: type: integer format: int64 description: Offset da página size: type: integer format: int64 description: Size da página orderBy: type: array items: type: object allOf: – #/definitions/orderBy description: Campos da ordenação dos registros a serem pesquisados orderBy: description: Dados de ordenação type: object required: – field – order properties: field: type: string description: Nome do campo a ser ordenado order: type: string allOf: – #/definitions/enumTypeOrder description: Tipo de ordenação do campo (ASC / DESC) agreementHeaderDeletion: description: Dados do resultado da exclusão do contrato type: object required: – agreement – isDeleted properties: agreement: type: object allOf: – #/definitions/agreementHeaderDataDeletionOutput description: Dados do contrato isDeleted: type: boolean description: Indicativo se o registro foi excluído errors: type: array items: type: string description: Lista com as mensagens de erro que impedem a exclusão do contrato agreementHeaderDataDeletionOutput: description: Dados do contrato para output da exclusão type: object required: – id properties: id: type: string description: Identificador do contrato number: type: integer format: int64 description: Número do contrato company: type: object allOf: – #/definitions/companyDataOutput description: Dados da empresa branch: type: object allOf: – #/definitions/personDataOutput description: Dados da filial person: type: object allOf: – #/definitions/personDataOutput description: Dados da pessoa agreementFinishingRec: description: Dados do resultado do encerramento dos contratos type: object required: – agreement – isFinished properties: agreement: type: object allOf: – #/definitions/agreementFinishingDataOutput description: Dados do contrato isFinished: type: boolean description: Indicativo se o contrato foi encerrado errors: type: array items: type: string description: Lista com as mensagens de erro que impedem o encerramento do contrato agreementFinishingDataOutput: description: Dados do contrato para output do encerramento type: object required: – id – number – company – branch – person properties: id: type: string description: Identificador do contrato number: type: integer format: int64 description: Número do contrato company: type: object allOf: – #/definitions/agreementFinishingCompanyDataOutput description: Dados da empresa do contrato branch: type: object allOf: – #/definitions/agreementFinishingBranchDataOutput description: Dados da filial do contrato person: type: object allOf: – #/definitions/agreementFinishingPersonDataOutput description: Dados da pessoa do contrato agreementFinishingCompanyDataOutput: description: Dados da empresa para output do encerramento do contrato type: object required: – id – code – tradeName properties: id: type: string description: Identificador da empresa code: type: integer format: int64 description: Código da empresa tradeName: type: string description: Nome fantasia da empresa agreementFinishingBranchDataOutput: description: Dados da empresa para output do encerramento do contrato type: object required: – id – code – documentNumber – tradeName properties: id: type: string description: Identificador da filial code: type: integer format: int64 description: Código da filial documentNumber: type: string description: Número do CNPJ ou CPF tradeName: type: string description: Nome fantasia da filial agreementFinishingPersonDataOutput: description: Dados da empresa para output do encerramento do contrato type: object required: – id – code – documentNumber – tradeName properties: id: type: string description: Identificador da pessoa code: type: integer format: int64 description: Código da pessoa documentNumber: type: string description: Número do CNPJ ou CPF tradeName: type: string description: Nome fantasia da pessoa agreementTermDataOutput: description: Dados da vigência para output type: object required: – id properties: id: type: string description: Identificador da vigência sequence: type: integer format: int64 description: Sequência da vigência agreementId: type: string description: Identificador do contrato startDate: type: string format: date description: Data inicial finalDate: type: string format: date description: Data final finishingDate: type: string format: date description: Data e encerramento dueDay: type: integer format: int64 description: Dia para vencimento billingAdvanceDays: type: integer format: int64 description: Quantidade de dias para antecipação da cobrança status: type: string allOf: – #/definitions/enumAgreementTermStatus description: Situação installmentError: type: string maxLength: 500 description: Erro de geração hasCompetence: type: boolean description: Possui competências geradas default: false dueDateType: type: string allOf: – #/definitions/enumDueDateType description: Tipo de vencimento termType: type: string allOf: – #/definitions/enumTermType description: Tipo de prazo da vigência billingDay: type: integer format: int64 description: Dia base para faturamento apportionmentStatus: type: string allOf: – #/definitions/enumApportionmentStatus description: Situação do rateio apportionmentError: type: string description: Erro do rateio finishingReason: type: object allOf: – #/definitions/defaultDataOutput description: Motivo do encerramento finishingNote: type: string description: Observação do encerramento itemDataInput: description: Dados do item para input type: object required: – transaction – quantity – measureUnit – price properties: itemProduct: type: object allOf: – #/definitions/productDataInput description: Dados do produto itemService: type: object allOf: – #/definitions/serviceDataInput description: Dados do serviço transaction: type: object allOf: – #/definitions/transactionDataInput description: Dados da transação quantity: type: number format: double description: Quantidade do item minimum: 0.0 maximum: 999999999.99999 measureUnit: type: object allOf: – #/definitions/measureUnitDataInput description: Dados da unidade de medida price: type: string description: Preço do item minimum: 0.0 maximum: 99999999999.9999999999 discountPercentage: type: number format: double description: Percentual de desconto minimum: 0.0 maximum: 999.99 priceList: type: object allOf: – #/definitions/priceListDataInput description: Dados da tabela de preço discountValue: type: string description: Valor de desconto minimum: 0.0 maximum: 9999999999999.99 financialAccount: type: object allOf: – #/definitions/financialAccountDataInput description: Dados da conta financeira costCenter: type: object allOf: – #/definitions/costCenterDataInput description: Dados do centro de custo representative: type: object allOf: – #/definitions/personDataInput description: Representante readjustmentIndex: type: object allOf: – #/definitions/indexDataInput description: Índice de reajuste readjustmentFrequency: type: integer format: int64 description: Periodicidade do reajuste maximum: 999 readjustmentDate: type: string format: date description: Data do próximo reajuste itemComplement: type: string description: Complemento do item productDataInput: description: Dados do produto para input type: object properties: id: type: string description: Identificador code: type: string maxLength: 23 description: Código serviceDataInput: description: Dados do serviço para input type: object properties: id: type: string description: Identificador code: type: string maxLength: 14 description: Código transactionDataInput: description: Dados da transação para input type: object properties: id: type: string description: Identificador code: type: string maxLength: 5 description: Código measureUnitDataInput: description: Dados da unidade de medida type: object properties: id: type: string description: Identificador code: type: string maxLength: 6 description: Código priceListDataInput: description: Dados da tabela de preço type: object properties: id: type: string description: Identificação code: type: string maxLength: 4 description: Código financialAccountDataInput: description: Dados da conta financeira type: object properties: id: type: string description: Identificação code: type: integer format: int64 description: Código minimum: 0 maximum: 9999999 costCenterDataInput: description: Dados do centro de custo type: object properties: id: type: string description: Identificação code: type: string maxLength: 9 description: Código itemDataCreateOutput: description: Dados do item para output type: object properties: itemDataOutput: type: object allOf: – #/definitions/itemDataOutput description: Dados do item para output errors: type: array items: type: string description: Mensagens de erro que impedem a inclusão do item defaultDataOutput: description: Dados padrão para output discriminator: _discriminator type: object required: – id – description – _discriminator properties: id: type: string description: Identificador code: type: string description: Código description: type: string description: Descrição _discriminator: type: string description: indexDataInput: description: Dados para input type: object properties: id: type: string description: Identificador measureUnitDataOutput: description: Dados da unidade de medida para output allOf: – #/definitions/defaultDataOutput – type: object properties: decimals: type: integer format: int64 description: Quantidade de casas decimais itemDeletion: description: Dados do resultado da exclusão do item type: object required: – item – isDeleted – errors properties: item: type: object allOf: – #/definitions/termItemDataDeletionOutput description: Dados do item isDeleted: type: boolean description: Indicativo se o registro foi excluído errors: type: array items: type: string minimum: 1 description: Mensagens de erro que impedem a exclusão do item termItemDataDeletionOutput: description: Dados do item da vigência para output da exclusão type: object required: – id properties: id: type: string description: Identificador do item itemProduct: type: object allOf: – #/definitions/defaultDataOutput description: Dados do produto itemService: type: object allOf: – #/definitions/defaultDataOutput description: Dados do serviço transaction: type: object allOf: – #/definitions/defaultDataOutput description: Dados da transação measureUnit: type: object allOf: – #/definitions/defaultDataOutput description: Dados da unidade de medida itemDataOutput: description: Dados do item para output type: object required: – id properties: id: type: string description: Identificador itemProduct: type: object allOf: – #/definitions/defaultDataOutput description: Dados do produto itemService: type: object allOf: – #/definitions/defaultDataOutput description: Dados do serviço transaction: type: object allOf: – #/definitions/defaultDataOutput description: Dados da transação quantity: type: number format: double description: Quantidade do item measureUnit: type: object allOf: – #/definitions/measureUnitDataOutput description: Dados da unidade de medida price: type: string description: Preço do item discountPercentage: type: number format: double description: Percentual de desconto priceList: type: object allOf: – #/definitions/defaultDataOutput description: Dados da tabela de preço grossValue: type: string description: Valor bruto discountValue: type: string description: Valor de desconto netValue: type: string description: Valor líquido financialAccount: type: object allOf: – #/definitions/defaultDataOutput description: Dados da conta financeira costCenter: type: object allOf: – #/definitions/defaultDataOutput description: Dados do centro de custo representative: type: object allOf: – #/definitions/defaultDataOutput description: Representante readjustmentIndex: type: object allOf: – #/definitions/defaultDataOutput description: Índice de reajuste readjustmentFrequency: type: integer format: int64 description: Periodicidade do reajuste readjustmentDate: type: string format: date description: Data do próximo reajuste readjustmentProcess: type: integer format: int64 description: Id do processo de reajuste de contrato availableBalance: type: string description: Valor em aberto totalBalance: type: string description: Valor total itemComplement: type: string description: Complemento do item salePriceListItem: type: object allOf: – #/definitions/defaultDataOutput description: Item da tabela de preço de venda salePriceListValidity: type: object allOf: – #/definitions/defaultDataOutput description: Validade da tabela de preço de venda paymentMethodDataInput: description: Dados da forma de pagamento para input type: object properties: id: type: string description: Identificador code: type: integer format: int64 description: Código minimum: 0 maximum: 99 termInstallmentDataOutput: description: Dados da competência para output type: object required: – id properties: id: type: string description: Identificador da competência installmentSequence: type: integer format: int64 description: Sequência description: type: string maxLength: 255 description: Descrição dueDate: type: string format: date description: Data de vencimento installmentDate: type: string format: date description: Data da competência paymentMethod: type: object allOf: – #/definitions/defaultDataOutput description: Dados da forma de pagamento value: type: string description: Valor da competência invoiceStatus: type: string allOf: – #/definitions/enumInvoiceStatus description: Situação do documento fiscal chargePaymentStatus: type: string allOf: – #/definitions/enumChargePaymentStatus description: Situação da cobrança/pagamento status: type: string allOf: – #/definitions/enumInstallmentStatus description: Situação da competência validationMessage: type: string description: Mensagem de validação invoiceAdditionalInformation: type: string description: Informações complementares para documento fiscal billingDate: type: string format: date description: Data base para faturamento cancellingReason: type: object allOf: – #/definitions/defaultDataOutput description: Motivo do cancelamento cancellingNote: type: string description: Observação do cancelamento cancellingDate: type: string format: date description: Data do cancelamento saleMeasureUnitOutput: description: Dados da unidade de medida para sugestão das informações do item allOf: – #/definitions/measureUnitDataOutput – type: object properties: measureUnit: type: string description: Unidade de medida reasonDataInput: description: Motivo de situação específica do contrato type: object properties: id: type: string description: Id do motivo code: type: integer format: int64 description: Código do motivo prepareRenewalDataOutput: description: Dados do contrato type: object required: – id properties: id: type: string description: Identificador único do contrato person: type: object allOf: – #/definitions/personDataOutput description: Dados da pessoa do contrato number: type: integer format: int64 description: Número do contrato description: type: string description: Descrição do contrato startDateLastTerm: type: string format: date description: Data inicial da vigência que será renovada finalDateLastTerm: type: string format: date description: Data final da vigência que será renovada startDateNewTerm: type: string format: date description: Data inicial da vigência que será renovada finalDateNewTerm: type: string format: date description: Data final da vigência que será renovada canRenew: type: boolean description: Identifica se o contrato será renovado validationMessage: type: string description: Mensagem de validação remainingDays: type: integer format: int64 description: Dias faltantes para o término da respectiva vigência agreementReadjustmentDataOutput: description: Item do contrato que pode ser reajustado type: object required: – id – termItemId – agreementId – termId properties: id: type: string description: Id da entidade termItemId: type: string description: Id do item da vigência agreementId: type: string description: Id do contrato termId: type: string description: Id da vigência number: type: integer format: int64 description: Número do contrato person: type: object allOf: – #/definitions/personDataOutput description: Dados da pessoa do contrato readjustmentDate: type: string format: date description: Data base do reajuste readjustmentIndex: type: object allOf: – #/definitions/defaultDataOutput description: Índice do reajuste item: type: object allOf: – #/definitions/defaultDataOutput description: Item que será reajustado lastReadjustmentDate: type: string format: date description: Data do último reajuste readjustmentPercentage: type: string description: Percentual do reajuste currentPrice: type: string description: Preço atual readjustedPrice: type: string description: Preço reajustado readjustmentFrequency: type: integer format: int64 description: Periodicidade do reajuste termStartDate: type: string format: date description: Data inicial da vigência do item termFinalDate: type: string format: date description: Data final da vigência do item note: type: string description: Observações readjustmentStartDate: type: string format: date-time description: Data de inicio do reajuste readjusted: type: boolean description: Item reajustado agreementClosureDataOutput: description: Dados do contrato para output do fechamento type: object required: – id – number – isClosed properties: id: type: string description: Identificador do contrato number: type: integer format: int64 description: Número do contrato company: type: object allOf: – #/definitions/companyDataOutput description: Dados da empresa branch: type: object allOf: – #/definitions/personDataOutput description: Dados da filial person: type: object allOf: – #/definitions/personDataOutput description: Dados da pessoa isClosed: type: boolean description: Indicativo se o contrato foi fechado errors: type: array items: type: string description: Lista com as mensagens de erro que impedem o fechamento do contrato adjustment: description: Record de ajuste type: object properties: id: type: string description: Id do erro da nota fiscal adjustmentEntityId: type: string description: Id da entidade de ajuste message: type: string maxLength: 1000 description: Mensagem de consistência adjustmentForm: type: string allOf: – #/definitions/enumAdjFrm description: Tela para ajuste recBalanceCalculation: description: Record de cálculo de valores total e aberto do contrato type: object required: – termItemIds – enumBalanceType properties: termItemIds: type: array items: type: string minimum: 1 description: Identificadores dos itens da vigência enumBalanceType: type: string allOf: – #/definitions/enumBalanceType description: Tipo de valor a ser calculado serieData: description: Série para faturamento de contrato type: object properties: id: type: string description: Id da serie code: type: string description: Código da serie description: type: string description: Descrição da serie agreementNumberControl: description: Controle de numeração do contrato type: object required: – e070fil properties: id: type: string format: uuid description: Id da entidade e070fil: type: string format: uuid description: Id da filial lastNumber: type: integer format: int64 description: Último número do contrato usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e031moe: description: Tabelas – Moedas type: object required: – codMoe – desMoe – sigMoe properties: id: type: string format: uuid description: Id da entidade codMoe: type: string maxLength: 3 description: Código Moeda desMoe: type: string maxLength: 30 description: Descrição sigMoe: type: string maxLength: 5 description: Sigla excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e006pai: description: Tabelas – Países type: object required: – codPai – nomPai – excluido 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: Código Moeda excluido: type: boolean description: Indica se o registro foi excluído extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070emp: description: Empresa type: object required: – codEmp – nomEmp – sigEmp properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome da empresa sigEmp: type: string maxLength: 100 description: Nome fantasia da empresa excluido: type: boolean description: Indicativo de exclusão do registro extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e007ufs: description: Tabelas – Estados type: object required: – sigUfs – nomUfs – e006pai – excluido 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 extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e008rai: description: Cidade type: object required: – codRai – nomCid – e007ufs – excluido 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 excluido: type: boolean description: Indica se o registro foi excluído extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070fil: description: Filial type: object required: – codFil – nomFil – sigFil properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Filial minimum: 0 maximum: 9999 nomFil: type: string maxLength: 100 description: Nome sigFil: type: string maxLength: 100 description: Fantasia tipEmp: type: string allOf: – #/definitions/enumTipEmp description: Tipo empresa tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo da pessoa numCgc: type: string maxLength: 18 description: NumCgC insEst: type: string maxLength: 25 description: Inscrição Estadual postalCodeFil: type: string description: CEP endFil: type: string maxLength: 100 description: Endereço nenFil: type: string maxLength: 60 description: Número cplEnd: type: string maxLength: 200 description: Complemento baiFil: type: string maxLength: 75 description: Bairro e007ufsSigUfs: type: object allOf: – #/definitions/e007ufs description: Estado e008rai: type: object allOf: – #/definitions/e008rai description: Cidade numFon: type: string maxLength: 20 description: Telefone intNet: type: string maxLength: 100 description: E-mail excluido: type: boolean description: Indica se o registro foi excluído extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação e070filCtrGer: type: object allOf: – #/definitions/e070filCtrGer description: Especialização contrato geral e070filComGer: type: object allOf: – #/definitions/e070filComGer description: Especialização comercial e070filComNfs: type: object allOf: – #/definitions/e070filComNfs description: Especialização – Nota de venda usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e001pes: description: Cadastro geral pessoa type: object required: – nomPes – codPes – apePes – tipPes properties: id: type: string format: uuid description: Id da entidade nomPes: type: string maxLength: 100 description: Nome da pessoa codPes: type: integer format: int64 description: Código Pessoa minimum: 0 maximum: 999999999 apePes: type: string maxLength: 50 description: Nome fantasia tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo da pessoa cnpCpf: type: string maxLength: 14 description: CNPJ/CPF insEst: type: string maxLength: 25 description: Inscrição Estadual postalCode: type: string description: CEP endPes: type: string maxLength: 100 description: Endereço numEnd: type: string maxLength: 60 description: Número cplEnd: type: string maxLength: 200 description: Complemento nomBai: type: string maxLength: 75 description: Bairro e006pai: type: object allOf: – #/definitions/e006pai description: Pais e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado e008rai: type: object allOf: – #/definitions/e008rai description: Cidade e085pes: type: object allOf: – #/definitions/e085pes description: Cliente e090pes: type: object allOf: – #/definitions/e090pes description: Representante excluido: type: boolean description: Indica se o registro foi excluído default: false sitPes: type: string allOf: – #/definitions/enumSitReg description: Situação pessoa fonPes: type: string maxLength: 20 description: Telefone fonPe2: type: string maxLength: 20 description: Telefone 2 intNet: type: string maxLength: 500 description: E-mail extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e090pes: description: Cadastros – Representantes type: object properties: id: type: string format: uuid description: id e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa sitReg: type: string allOf: – #/definitions/enumSitReg description: Situação do representante excluido: type: boolean description: Indica se o registro foi excluído extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e001end: description: Endereço de pessoa type: object required: – excluido properties: id: type: string format: uuid description: Id da entidade e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa indEnt: type: boolean description: Indicativo se o endereço é utilizado para entrega default: true indCob: type: boolean description: Indicativo se o endereço é utilizado para cobrança default: true postalCode: type: string description: CEP endPes: type: string maxLength: 100 description: Endereço nenEnd: type: string maxLength: 60 description: Número cplEnd: type: string maxLength: 200 description: Complemento baiEnd: type: string maxLength: 75 description: Bairro prxEnd: type: string maxLength: 200 description: Ponto de referência e006pai: type: object allOf: – #/definitions/e006pai description: Pais e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado e008rai: type: object allOf: – #/definitions/e008rai description: Cidade fonRes: type: string maxLength: 100 description: Telefone emaRes: type: string maxLength: 100 description: E-mail sitEnd: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e066fpg: description: Tabelas – Formas de Pagamento type: object required: – e070emp – codFpg – desFpg – abrFpg – tipFpg – sitFpg – excluido properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFpg: type: integer format: int64 description: Código Forma Pagamento minimum: 0 maximum: 99 desFpg: type: string maxLength: 30 description: Descrição abrFpg: type: string maxLength: 10 description: Abreviação da forma de pagamento tipFpg: type: string allOf: – #/definitions/enumTipFpg description: Tipo pagamento sitFpg: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e028cpg: description: Condição de pagamento – Foundation type: object required: – e070emp – codCpg – desCpg – abrCpg – aplCpg – sitCpg – qtdPar – diaEsp – tipPar – frePar – segPar – embPar – outPar – ipiPar – icmPar – subPar – encPar properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codCpg: type: string maxLength: 6 description: Código da condição de pagamento desCpg: type: string maxLength: 50 description: Descrição da condição de pagamento abrCpg: type: string maxLength: 10 description: Abreviatura aplCpg: type: string allOf: – #/definitions/enumAplCpg description: Aplicação sitCpg: type: string allOf: – #/definitions/enumSitReg description: Situação przMed: type: integer format: int64 description: Prazo Médio minimum: 0 maximum: 999 qtdPar: type: integer format: int64 description: Quantidade Parcelas minimum: 0 maximum: 999 diaEsp: type: string allOf: – #/definitions/enumDiaEsp description: Dia Vencimento Semana tipPar: type: string allOf: – #/definitions/enumTipPar description: Tipo Parcela diaMe1: type: integer format: int64 description: Primeiro dia especial do mês para vencimento das parcelas minimum: 0 maximum: 31 diaMe2: type: integer format: int64 description: Segundo dia especial do mês para vencimento das parcelas minimum: 0 maximum: 31 diaMe3: type: integer format: int64 description: Terceiro dia especial do mês para vencimento das parcelas minimum: 0 maximum: 31 frePar: type: boolean description: Indicativo se o valor total do frete deve estar na 1ª parcela segPar: type: boolean description: Indicativo se o valor total do seguro deve estar na 1ª parcela embPar: type: boolean description: Indicativo se o valor total das embalagens deve estar na 1ª parcela outPar: type: boolean description: Indicativo se o valor total das outras despesas deve estar na 1ª parcela ipiPar: type: boolean description: Indicativo se o valor total do IPI deve estar na 1ª parcela icmPar: type: boolean description: Indicativo se o valor total do ICMS deve estar na 1ª parcela subPar: type: boolean description: Indicativo se o valor total do ICMS substituído deve estar na 1ª parcela encPar: type: boolean description: Indicativo se o valor total dos encargos deve estar na 1ª parcela issPar: type: boolean description: Indicativo se o valor total do ISS deve estar na 1ª parcela perEnc: type: number format: double description: Percentual de encargos maximum: 100.00 retIss: type: boolean description: Indicativo se o valor total do ISS retido deve ser descontado da 1ª parcela irfPar: type: boolean description: Indicativo se o valor total do irrf deve estar na 1ª parcela diaFix: type: boolean description: Indicativo se o dia do vencimento é fixo para períodos de 30 em 30 dias venDsc: type: number format: double description: Percentual a acrescentar ou diminuir para formação do preço de venda minimum: -999.99 maximum: 999.99 perCom: type: number format: double description: Percentual a acrescentar ou diminuir à comissão do representante minimum: -999.99 maximum: 999.99 redCom: type: number format: double description: Percentual redutor do valor base comissão minimum: 0.00 maximum: 999.99 inssPrimeiraParcela: type: boolean description: Deduzir INSS da 1ª parcela default: false csrfPrimeiraParcela: type: boolean description: Deduzir CSRF da 1ª parcela default: false excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e083ori: description: Cadastros – Origens de Produto type: object required: – e070emp – codOri – desOri – tipPro properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codOri: type: string maxLength: 3 description: Código Origem desOri: type: string maxLength: 40 description: Descrição tipPro: type: string allOf: – #/definitions/enumTipPro description: Tipo Produto excluido: type: boolean description: Indica se o registro foi excluído extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e012fam: description: Cadastros – Famílias type: object required: – e070emp – e083ori – codFam – desFam properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e083ori: type: object allOf: – #/definitions/e083ori description: Origem Produto codFam: type: string maxLength: 6 description: Família desFam: type: string maxLength: 50 description: Descrição sitFam: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e075der: description: Cadastros – Produtos – Derivações type: object required: – codDer – desDer – sitDer properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e012fam: type: object allOf: – #/definitions/e012fam description: Família codDer: type: string maxLength: 23 description: Código do produto desDer: type: string maxLength: 120 description: Descrição do produto desCpl: type: string maxLength: 255 description: Descrição Complementar sitDer: type: string allOf: – #/definitions/enumSitReg description: Situação pesBru: type: number format: double description: Peso Bruto minimum: 0.00 maximum: 999999.99999 pesLiq: type: number format: double description: Peso Líquido minimum: 0.00 maximum: 999999.99999 excluido: type: boolean description: Indica se o registro foi excluído default: false e075derComGer: type: object allOf: – #/definitions/e075derComGer description: especialização do produto codBar: type: string maxLength: 14 description: Código de barras codBa2: type: string maxLength: 30 description: Código barras livre codGtn: type: string maxLength: 14 description: GTIN unidade tributável extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e015med: description: Cadastros – Unidades de Medida type: object required: – uniMed – desMed properties: id: type: string format: uuid description: Id da entidade uniMed: type: string maxLength: 6 description: Unidade Medida desMed: type: string maxLength: 100 description: Descrição qtdDec: type: integer format: int64 description: Quantidade Decimais minimum: 0 maximum: 9 excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e080ser: description: Cadastros – Serviços type: object required: – e012fam – sitSer – codSer – desSer – excluido properties: id: type: string format: uuid description: Id da entidade e012fam: type: object allOf: – #/definitions/e012fam description: Família sitSer: type: string allOf: – #/definitions/enumSitReg description: Situação cplSer: type: string maxLength: 250 description: Complemento e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codSer: type: string maxLength: 14 description: Serviço desSer: type: string maxLength: 70 description: Descrição excluido: type: boolean description: Indica se o registro foi excluído extIntSts: type: string maxLength: 255 description: Indica status da replicação extIntMsg: type: string maxLength: 255 description: Indica a mensagem da replicação e015med: type: object allOf: – #/definitions/e015med description: Unidade de Medida usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e001tns: description: Tabelas – Transações type: object required: – e070emp – codTns – desTns – lisMod – aceMan properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codTns: type: string maxLength: 5 description: Código da transação desTns: type: string maxLength: 60 description: Descrição da transação lisMod: type: string allOf: – #/definitions/enumLisMod description: Módulo detTns: type: string maxLength: 599 description: Detalhes Transação aceMan: type: boolean description: Aceita Manual sitTns: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false e001tnsComNfs: type: object allOf: – #/definitions/e001tnsComNfs description: Especialização extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e081tab: description: Tabelas – Tabelas de Preços de Venda – Dados Gerais type: object required: – codTpr – desTpr – abrTpr – sitReg properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e031moe: type: object allOf: – #/definitions/e031moe description: Moeda e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado codTpr: type: string maxLength: 4 description: Código Tabela Preço desTpr: type: string maxLength: 250 description: Descrição abrTpr: type: string maxLength: 10 description: Abreviatura sitReg: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e081tpr: description: Tabelas – Tabelas de Preços de Venda – Validades type: object required: – desVal – datIni – datFim – sitReg properties: id: type: string format: uuid description: Id da entidade e081tab: type: object allOf: – #/definitions/e081tab description: Tabela Preço desVal: type: string maxLength: 250 description: Descrição da validade datIni: type: string format: date description: Validade Inicial datFim: type: string format: date description: Validade Final perDsc: type: number format: double description: % Desconto minimum: 0.00 maximum: 999.99 perCom: type: number format: double description: % Comissão minimum: -999.99 maximum: 999.99 sitReg: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e081itp: description: Tabelas – Tabelas de Preços de Venda – Itens de Produto type: object required: – qtdMax – preBas – sitReg properties: id: type: string format: uuid description: Id da entidade proSer: type: string allOf: – #/definitions/enumProSer description: Tipo do item e081tpr: type: object allOf: – #/definitions/e081tpr description: Validade Inicial e075der: type: object allOf: – #/definitions/e075der description: Produto e080ser: type: object allOf: – #/definitions/e080ser description: Servico e028cpg: type: object allOf: – #/definitions/e028cpg description: Unidade de Medida e015med: type: object allOf: – #/definitions/e015med description: Unidade de Medida qtdMax: type: integer format: int64 description: Até Quantidade minimum: 0 maximum: 999999999 preBas: type: string description: Preço Base minimum: 0.00 maximum: 9999999999999.99 perDsc: type: number format: double description: % Desconto minimum: 0.00 maximum: 999.99 perCom: type: number format: double description: % Comissão minimum: -999.99 maximum: 999.99 obsItp: type: string maxLength: 99 description: Observação sitReg: type: string allOf: – #/definitions/enumSitReg description: Situação extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e091plf: description: Tabelas – Plano Financeiro – Contas type: object properties: id: type: string format: uuid description: Id da entidade ctaFin: type: integer format: int64 description: Conta Financeira Reduzida minimum: 0 maximum: 9999999 desCta: type: string maxLength: 80 description: Nomenclatura abrCta: type: string maxLength: 20 description: Abreviatura e070emp: type: object allOf: – #/definitions/e070emp description: Empresa 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 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e044ccu: description: Cadastros – Centros de Custos type: object properties: id: type: string format: uuid description: Id da entidade codCcu: type: string maxLength: 9 description: Código do centro de custos desCcu: type: string maxLength: 80 description: Descrição do centro de custos abrCcu: type: string maxLength: 20 description: Abreviatura do centro de custos e070emp: type: object allOf: – #/definitions/e070emp description: Empresa 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 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e085pes: description: Cadastros – Clientes type: object properties: id: type: string format: uuid description: Id da entidade – Chave da e001pes e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa sitCli: type: string allOf: – #/definitions/enumSitReg description: Situação do cliente excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Indica status da replicação extIntMsg: type: string description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e085hclComGer: description: Definições do cliente – Comercial geral type: object properties: id: type: string format: uuid description: Id da entidade e070fil: type: object allOf: – #/definitions/e070fil description: Filial e085pes: type: object allOf: – #/definitions/e085pes description: Cliente e090pes: type: object allOf: – #/definitions/e090pes description: Representante e028cpg: type: object allOf: – #/definitions/e028cpg description: Condição de pagamento e066fpg: type: object allOf: – #/definitions/e066fpg description: Forma de pagamento e081tab: type: object allOf: – #/definitions/e081tab description: Tabela de preço e001endSeqEnt: type: object allOf: – #/definitions/e001end description: Endereço de entrega sitReg: type: string allOf: – #/definitions/enumSitReg description: Situação qtdDcv: type: integer format: int64 description: Quantidade Dias Vencimento minimum: 0 maximum: 999 criEdv: type: string allOf: – #/definitions/enumAntPos description: Critério Dia Vencimento diaEsp: type: string allOf: – #/definitions/enumDiaEsp description: Dia Vencimento Semana diaMe1: type: integer format: int64 description: 1º Dia Especial Mês minimum: 0 maximum: 99 diaMe2: type: integer format: int64 description: 2º Dia Especial Mês minimum: 0 maximum: 99 diaMe3: type: integer format: int64 description: 3º Dia Especial Mês minimum: 0 maximum: 99 excluido: type: boolean description: Excluído default: false extIntSts: type: string description: Indica status da replicação extIntMsg: type: string description: Indica a mensagem da replicação exiLcp: type: boolean description: Indicativo se exige a ligação cliente x item usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: agreementHeader: description: Cabeçalho do contrato type: object required: – e070fil – e001pes – module – agreementType – issueDate – recurrence properties: id: type: string format: uuid description: Id do contrato e070fil: type: object allOf: – #/definitions/e070fil description: Filial e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa module: type: string allOf: – #/definitions/enumAgreementModule description: Módulo do contrato agreementType: type: string allOf: – #/definitions/enumAgreementType description: Espécie do contrato number: type: integer format: int64 description: Número description: type: string maxLength: 255 description: Descrição issueDate: type: string format: date-time description: Data e hora de emissão recurrence: type: string allOf: – #/definitions/enumAgreementRecurrence description: Recorrência status: type: string allOf: – #/definitions/enumAgreementStatus description: Situação agreementTerm: type: array items: type: object allOf: – #/definitions/agreementTerm description: Vigências do contrato cancellingReason: type: object allOf: – #/definitions/e021mot description: Motivo de cancelamento do contrato finishingDate: type: string format: date description: Data de encerramento do contrato cancellingDate: type: string format: date description: Data de cancelamento do contrato lastBillingDate: type: string format: date-time description: Data do último faturamento lastReadjustmentDate: type: string format: date description: Data do último reajuste invoiceAdditionalInformation: type: string description: Informações complementares para documento fiscal situationReason: type: object allOf: – #/definitions/e021mot description: Motivo de situação específica do contrato readjustmentHistory: type: array items: type: object allOf: – #/definitions/readjustmentHistory description: Histórico de reajuste do contrato finishingNote: type: string description: Observação de encerramento do contrato renewalHistory: type: array items: type: object allOf: – #/definitions/renewalHistory description: Histórico de renovação do contrato rehabilitationHistory: type: array items: type: object allOf: – #/definitions/rehabilitationHistory description: Histórico de reabilitação do contrato e020snf: type: object allOf: – #/definitions/e020snf description: Série finishingReason: type: object allOf: – #/definitions/e021mot description: Motivo de encerramento do contrato cancellingNote: type: string description: Observação de cancelamento do contrato usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: agreementTerm: description: Vigências do contrato type: object required: – termSequence – startDate – dueDay – dueDateType – termType properties: id: type: string format: uuid description: Id da vigência agreementHeader: type: object allOf: – #/definitions/agreementHeader description: Contrato termSequence: type: integer format: int64 description: Sequência startDate: type: string format: date description: Data de início finalDate: type: string format: date description: Data de término finishingDate: type: string format: date description: Data de encerramento dueDay: type: integer format: int64 description: Dia de vencimento minimum: 0 maximum: 99 billingAdvanceDays: type: integer format: int64 description: Quantidade de dias para antecipação da cobrança/pagamento minimum: 0 maximum: 999 status: type: string allOf: – #/definitions/enumAgreementTermStatus description: Situação termItem: type: array items: type: object allOf: – #/definitions/termItem description: Itens da vigência do contrato termInstallment: type: array items: type: object allOf: – #/definitions/termInstallment description: Competências da vigência do contrato installmentError: type: string maxLength: 500 description: Erro de geração de parcelas dueDateType: type: string allOf: – #/definitions/enumDueDateType description: Tipo de vencimento termType: type: string allOf: – #/definitions/enumTermType description: Tipo de prazo da vigência billingDay: type: integer format: int64 description: Dia base para faturamento minimum: 0 maximum: 31 apportionmentStatus: type: string allOf: – #/definitions/enumApportionmentStatus description: Situação do rateio apportionmentError: type: string maxLength: 500 description: Erro do rateio finishingNote: type: string maxLength: 255 description: Observação de encerramento da vigência finishingReason: type: object allOf: – #/definitions/e021mot description: Motivo de encerramento da vigência usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: termItem: description: Itens da vigência do contrato type: object required: – e001tns – quantity – e015med – price properties: id: type: string format: uuid description: Id do item agreementTerm: type: object allOf: – #/definitions/agreementTerm description: Vigência e075der: type: object allOf: – #/definitions/e075der description: Produto e080ser: type: object allOf: – #/definitions/e080ser description: Serviço e001tns: type: object allOf: – #/definitions/e001tns description: Transação quantity: type: number format: double description: Quantidade minimum: 0.00 maximum: 999999999.99999 e015med: type: object allOf: – #/definitions/e015med description: Unidade de medida price: type: string description: Preço minimum: 0.00 maximum: 99999999999.9999999999 discountPercentage: type: number format: double description: Percentual de desconto minimum: 0.00 maximum: 999.99 e081tab: type: object allOf: – #/definitions/e081tab description: Tabela de preço grossValue: type: string description: Valor bruto minimum: 0.00 maximum: 9999999999999.99 discountValue: type: string description: Valor de desconto minimum: 0.00 maximum: 9999999999999.99 netValue: type: string description: Valor líquido minimum: 0.00 maximum: 9999999999999.99 e091plf: type: object allOf: – #/definitions/e091plf description: Conta financeira e044ccu: type: object allOf: – #/definitions/e044ccu description: Centro de custo e090pes: type: object allOf: – #/definitions/e090pes description: Representante lastReadjustmentDate: type: string format: date description: Data do último reajuste readjustmentIndex: type: object allOf: – #/definitions/e031moe description: Índice de reajuste readjustmentFrequency: type: integer format: int64 description: Periodicidade do reajuste maximum: 999 readjustmentDate: type: string format: date description: Data do próximo reajuste readjustmentProcess: type: integer format: int64 description: Id do processo de reajuste em análise availableBalance: type: string description: Valor em aberto minimum: 0.00 maximum: 9999999999999.99 totalBalance: type: string description: Valor total minimum: 0.00 maximum: 9999999999999.99 itemComplement: type: string description: Complemento do item usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: termInstallment: description: Competências da vigência do contrato type: object required: – installmentDate – dueDate properties: id: type: string format: uuid description: Id da competência installmentSequence: type: integer format: int64 description: Sequência da competência description: type: string maxLength: 255 description: Descrição agreementTerm: type: object allOf: – #/definitions/agreementTerm description: Vigência installmentDate: type: string format: date description: Data da competência e066fpg: type: object allOf: – #/definitions/e066fpg description: Forma de pagamento installmentItem: type: array items: type: object allOf: – #/definitions/installmentItem description: Itens da competência installmentChargePayment: type: array items: type: object allOf: – #/definitions/installmentChargePayment description: Cobranças/Pagamentos da competência installmentInvoice: type: array items: type: object allOf: – #/definitions/installmentInvoice description: Notas fiscais da competência dueDate: type: string format: date description: Vencimento da competência status: type: string allOf: – #/definitions/enumInstallmentStatus description: Situação da competência invoiceAdditionalInformation: type: string description: Informações complementares para documento fiscal billingDate: type: string format: date description: Data base para faturamento cancellingNote: type: string maxLength: 255 description: Observação de cancelamento da competência cancellingReason: type: object allOf: – #/definitions/e021mot description: Motivo de cancelamento da competência cancellingDate: type: string format: date description: Data de cancelamento da competência billingHistory: type: array items: type: object allOf: – #/definitions/billingHistory description: Históricos de faturamento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: installmentItem: description: Itens da competência type: object required: – e001tns – quantity – e015med – price properties: id: type: string format: uuid description: Id do item installment: type: object allOf: – #/definitions/termInstallment description: Competência e075der: type: object allOf: – #/definitions/e075der description: Produto e080ser: type: object allOf: – #/definitions/e080ser description: Serviço e001tns: type: object allOf: – #/definitions/e001tns description: Transação quantity: type: number format: double description: Quantidade minimum: 0.00 maximum: 999999999.99999 e015med: type: object allOf: – #/definitions/e015med description: Unidade de medida price: type: string description: Preço minimum: 0.00 maximum: 99999999999.9999999999 discountPercentage: type: number format: double description: Percentual de desconto minimum: 0.00 maximum: 999.99 e081tab: type: object allOf: – #/definitions/e081tab description: Tabela de preço grossValue: type: string description: Valor bruto minimum: 0.00 maximum: 9999999999999.99 discountValue: type: string description: Valor de desconto minimum: 0.00 maximum: 9999999999999.99 netValue: type: string description: Valor líquido minimum: 0.00 maximum: 9999999999999.99 e091plf: type: object allOf: – #/definitions/e091plf description: Conta financeira e044ccu: type: object allOf: – #/definitions/e044ccu description: Centro de custo e090pes: type: object allOf: – #/definitions/e090pes description: Representante termItemId: type: string format: uuid description: Id do item da vigência itemComplement: type: string description: Complemento do item usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: installmentChargePayment: description: Cobranças/Pagamentos da competência type: object required: – chargePaymentType – status properties: id: type: string format: uuid description: Id da cobrança/pagamento da competência installment: type: object allOf: – #/definitions/termInstallment description: Competência chargePaymentType: type: string allOf: – #/definitions/enumChargePaymentType description: Tipo chargePayment: type: string description: Id do título de cobrança/pagamento chargePaymentNumber: type: string description: Número do título de cobrança/pagamento e070fil: type: object allOf: – #/definitions/e070fil description: Filial chargePaymentCode: type: string description: Código do tipo do título chargePaymentValue: type: string description: Valor da cobrança status: type: string allOf: – #/definitions/enumChargePaymentStatus description: Situação invoiceChargePayment: type: array items: type: object allOf: – #/definitions/invoiceChargePayment description: Ligação das notas fiscais com as cobranças/pagamentos usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: installmentInvoice: description: Notas fiscais da competência type: object required: – invoiceType – status properties: id: type: string format: uuid description: Id da nota fiscal da competência installment: type: object allOf: – #/definitions/termInstallment description: Competência invoiceType: type: string allOf: – #/definitions/enumInvoiceType description: Tipo da nota fiscal e001end: type: object allOf: – #/definitions/e001end description: Endereço de entrega/prestação do serviço invoice: type: string description: Id da nota fiscal invoiceNumber: type: string description: Número da nota fiscal status: type: string allOf: – #/definitions/enumInvoiceStatus description: Situação invoiceChargePayment: type: array items: type: object allOf: – #/definitions/invoiceChargePayment description: Ligação das notas fiscais com as cobranças/pagamentos validationMessage: type: string description: Mensagem de validação da nota fiscal seriesCode: type: string description: Código da série netValue: type: string description: Valor líquido da nota installmentInvoiceErrors: type: array items: type: object allOf: – #/definitions/installmentInvoiceErrors description: Erros na geração da nota fiscal usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: installmentInvoiceErrors: description: Erros na geração da nota fiscal type: object properties: id: type: string format: uuid description: Id do erro da nota fiscal adjustmentEntityId: type: string format: uuid description: Id da entity de ajuste installmentInvoice: type: object allOf: – #/definitions/installmentInvoice description: Nota fiscal message: type: string description: Mesangem de erro adjustmentForm: type: string allOf: – #/definitions/enumAdjFrm description: Tela para ajuste usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: invoiceChargePayment: description: Ligação das notas fiscais com as cobranças/pagamentos type: object properties: id: type: string format: uuid description: Id da ligação invoice: type: object allOf: – #/definitions/installmentInvoice description: Id da nota fiscal chargePayment: type: object allOf: – #/definitions/installmentChargePayment description: Situação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070filComGer: description: Especialização da filial para vendas type: object required: – id properties: id: type: string format: uuid description: Id da entidade e070fil: type: object allOf: – #/definitions/e070fil description: Filial venPcl: type: boolean description: Indicativo se exige na venda a ligação do item com o cliente nfeSer: type: boolean description: Gerar serviço na NF-e default: false excluido: type: boolean description: Indicativo se o registro está excluído usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e075ppc: description: Ligação entre cliente e produto/serviço type: object required: – id – e085pes properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Id da empresa e075der: type: object allOf: – #/definitions/e075der description: Id do produto e080ser: type: object allOf: – #/definitions/e080ser description: Id do serviço proSer: type: string allOf: – #/definitions/enumProSer description: Indicativo se o item da ligação é um produto ou serviço iteCli: type: string maxLength: 30 description: Código do item no cliente desCli: type: string maxLength: 70 description: Descrição do item no cliente sitPpc: type: string allOf: – #/definitions/enumSitReg description: Situação da ligação e085pes: type: object allOf: – #/definitions/e085pes description: Id do cliente e015medVen: type: object allOf: – #/definitions/e015med description: Id da unidade de medida de venda usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e080serComGer: description: Especialização do serviço para vendas type: object required: – id properties: id: type: string format: uuid description: Id da entidade indPpc: type: boolean description: Indicativo se existe ligação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e012famComGer: description: Especialização da família para vendas type: object required: – id properties: id: type: string format: uuid description: Id da entidade espPro: type: integer format: int64 description: Decimais para o preço de venda minimum: 2 maximum: 9999 excluido: type: boolean description: Indicativo se o registro está excluído usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e001tnsCplImpSai: description: Especialização da transação para tributos de saída type: object required: – id properties: id: type: string format: uuid description: Id da entidade venNat: type: string maxLength: 5 description: Natureza de operação venTcf: type: string allOf: – #/definitions/enumAplNop description: Aplicação da natureza de operação excluido: type: boolean description: Indicativo se o registro está excluído usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e021mot: description: Tabelas – Motivos das Situações das Tabelas type: object properties: id: type: string format: uuid description: Id da entidade codMot: type: integer format: int64 description: Motivo minimum: 0 maximum: 999999 desMot: type: string maxLength: 30 description: Descrição aplMot: type: string allOf: – #/definitions/enumAplMot description: Aplicação dos motivos das situações das tabelas excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e009ppeComNfv: description: Parâmetros por estado type: object required: – e007ufs – e070fil properties: id: type: string format: uuid description: Id da entidade e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado e070fil: type: object allOf: – #/definitions/e070fil description: Filial e001tnsVenTfp: type: object allOf: – #/definitions/e001tns description: Transação padrão para NF saída de produtos do estabelecimento a contribuinte e001tnsVenTfn: type: object allOf: – #/definitions/e001tns description: Transação padrão para NF saída de produtos do estabelecimento não contribuinte e001tnsVenTpa: type: object allOf: – #/definitions/e001tns description: Transação padrão para NF saída de produtos adquiridos p/ comercialização a contribuinte e001tnsVenTpn: type: object allOf: – #/definitions/e001tns description: Transação padrão para NF saída de produtos adquiridos p/ comercialização a não contribuinte e001tnsVenTfs: type: object allOf: – #/definitions/e001tns description: Transação padrão para NF saída de serviços e001tnsVenTdp: type: object allOf: – #/definitions/e001tns description: Transação padrão de devolução de itens de produto e001tnsVenTds: type: object allOf: – #/definitions/e001tns description: Transação padrão de devolução de itens de serviço e001tnsTnsRem: type: object allOf: – #/definitions/e001tns description: Transação para Notas Fiscais de Remessa e001tnsTnsRet: type: object allOf: – #/definitions/e001tns description: Transação para Notas Fiscais de Retorno e001tnsVenTsm: type: object allOf: – #/definitions/e001tns description: Transação padrão para NF de simples remessa e001tnsTnsAst: type: object allOf: – #/definitions/e001tns description: Transação mercadoria de subst. trib. na condição de contribuinte substituído usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e075derComGer: description: Cadastros – Produtos – Derivações type: object required: – indVen – indPpc properties: id: type: string format: uuid description: Id da entidade e075der: type: object allOf: – #/definitions/e075der description: Id do produto qtdBcp: type: number format: double description: Quantidade Base para Cálculo de Preço minimum: 0.00 maximum: 999999999.99999 proVes: type: boolean description: Produto vendido separadamente? regAnv: type: string maxLength: 13 description: Número registro Anvisa motAnv: type: string maxLength: 255 description: Motivo da isenção da Anvisa indVen: type: boolean description: Indicativo se o produto pode ser vendido indPpc: type: boolean description: Produto por Cliente qtdMve: type: number format: double description: Quantidade Múltipla Vendas minimum: 0.00 maximum: 9999999.99999 codAgm: type: string maxLength: 5 description: Agrup. Preço parCom: type: boolean description: Comissionado ? uniBcp: type: string maxLength: 3 description: Unidade Medida (Cálculo de preço) perGas: type: number format: double description: % Gás Natural minimum: 0.00 maximum: 999.99 indEnc: type: boolean description: Produto Sob Encomenda perGlp: type: number format: double description: Percentual do GLP derivado do petróleo no produto GLP minimum: 0.00 maximum: 999.99 perGni: type: number format: double description: Percentual de Gás Natural Importado – GLGNi para o produto GLP minimum: 0.00 maximum: 999.99 e015medVen: type: object allOf: – #/definitions/e015med description: 3ª Unidade Medida infAdProd: type: string maxLength: 500 description: Informações adicionais do produto para NF-e desNfv: type: string maxLength: 120 description: Descrição p/ Nota Fiscal extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação volumeMeasureUnit: type: object allOf: – #/definitions/e015med description: Unidade de medida do volume usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e001tnsComNfs: description: Especialização comercial nota de venda – Transação type: object properties: id: type: string format: uuid description: Id da entidade e001tns: type: object allOf: – #/definitions/e001tns description: Transação venFat: type: boolean description: Transação considera nota fiscal saída como faturamento e p/ histórico venAcp: type: boolean description: Transação de nota fiscal saída exige pedido de venda default: false venAcn: type: boolean description: Transação de nota fiscal saída exige nota fiscal de entrada default: false opeVen: type: string allOf: – #/definitions/enumOpeVen description: Tipo da operação de venda obrCps: type: boolean description: Indicativo se é obrigatório informar o código de produto/serviço nas NFS gerRec: type: boolean description: Indicativo se deve gerar nota fiscal de recibo de prestação de serviço default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: readjustmentHistory: description: Histórico de reajuste do contrato type: object properties: id: type: string format: uuid description: Id do histórico readjustmentDate: type: string format: date-time description: Data e hora do reajuste readjustmentUser: type: string description: Usuário do reajuste agreementHeader: type: object allOf: – #/definitions/agreementHeader description: Contrato reajustado itemCode: type: string description: Código do item reajustado itemDescription: type: string description: Descrição do item reajustado previousPrice: type: string description: Preço antes do reajuste readjustmentBaseDate: type: string format: date description: Data base do reajuste readjustmentIndex: type: object allOf: – #/definitions/e031moe description: Índice do reajuste readjustmentPercentage: type: number format: double description: Percentual do reajuste readjustmentPrice: type: string description: Preço reajustado readjustmentNote: type: string description: Observação do reajuste usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: renewalHistory: description: Histórico de renovação do contrato type: object required: – id – renewDate – renewUser – renewed properties: id: type: string format: uuid description: Id do histórico agreementHeader: type: object allOf: – #/definitions/agreementHeader description: Contrato renovado renewDate: type: string format: date-time description: Data e hora da renovação renewUser: type: string description: Usuário que gerou a renovação sequenceTerm: type: integer format: int64 description: Sequencia da vigência gerada startDate: type: string format: date description: Data inicial da vigência renovada finalDate: type: string format: date description: Data final da vigência renovada renewed: type: boolean description: Contrato foi renovado? validationMessage: type: string description: Mensagem de validação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: agreementShareReport: description: Relatório de compartilhamento do contrato de venda type: object required: – agreementSharingMethod – reportTicket properties: id: type: string format: uuid description: Id da entidade agreementSharingMethod: type: string allOf: – #/definitions/enumAgreementSharingMethod description: Tipo de compartilhamento reportTicket: type: string description: Ticket do relatório phoneNumber: type: string maxLength: 20 description: Número de telefone para o compartilhamento agreementId: type: string format: uuid description: Identificador do Contrato email: type: string description: Email para o compartilhamento emailTicket: type: string description: Ticket do envio por email agreementModule: type: string allOf: – #/definitions/enumAgreementModule description: Módulo do contrato usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070filCtrGer: description: Cadastros – Filiais – Contratos – Geral type: object properties: id: type: string format: uuid description: Id da entidade e070fil: type: object allOf: – #/definitions/e070fil description: Filial readjustmentProcessId: type: integer format: int64 description: Id do fluxo de aprovação do reajuste de contrato automaticReadjustments: type: boolean description: Reajuste automático dos itens da vigência default: false readjustmentWorkflow: type: boolean description: Identifica se o reajuste utiliza a aprovação do BPM default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: readjustmentWorkflow: description: Armazenamento temporário de contratos em análise do BPM type: object required: – e070fil – agreementHeader – agreementTerm – processInstanceId – agreementNumber – e001pes – termStartDate – termFinalDate – readjustmentDate – e080ser – currentPrice properties: id: type: string format: uuid description: Id da entidade termItem: type: object allOf: – #/definitions/termItem description: Item da vigência e070fil: type: object allOf: – #/definitions/e070fil description: Filial agreementHeader: type: object allOf: – #/definitions/agreementHeader description: Contrato agreementTerm: type: object allOf: – #/definitions/agreementTerm description: Vigência processInstanceId: type: integer format: int64 description: Identificador do número do processo no BPM readjusted: type: boolean description: Item reajustado agreementNumber: type: integer format: int64 description: Número do contrato e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa termStartDate: type: string format: date description: Data inicial da vigência do item termFinalDate: type: string format: date description: Data final da vigência do item readjustmentDate: type: string format: date description: Data do próximo reajuste readjustmentIndex: type: object allOf: – #/definitions/e031moe description: Índice do reajuste (e031moe) readjustmentFrequency: type: integer format: int64 description: Periodicidade do reajuste e080ser: type: object allOf: – #/definitions/e080ser description: Item de serviço lastReadjustmentDate: type: string format: date description: Data do último reajuste readjustmentPercentage: type: string description: Percentual do reajuste currentPrice: type: string description: Preço atual readjustedPrice: type: string description: Preço reajustado note: type: string description: Observação readjustmentStartDate: type: string format: date-time description: Data inicial da geração do reajuste usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e099usuCtrGer: description: Permissões de usuário para contratos type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codUsu: type: string description: Código do usuário nomUsu: type: string description: Nome do usuário ctrFat: type: boolean description: Permite faturar contratos ctrRjt: type: boolean description: Permite reajustar contratos ctrEnc: type: boolean description: Permite encerrar contratos ctrRen: type: boolean description: Permite renovar contratos ctrFec: type: boolean description: Permite fechar contratos ctrImp: type: boolean description: Permite imprimir contratos ctrCpt: type: boolean description: Permite compartilhar contratos ctrCan: type: boolean description: Permite cancelar contratos ctrRbt: type: boolean description: Permite reabilitar contratos ctrEma: type: boolean description: Permite incluir emails manualmente ao compartilhar contratos ctrCon: type: boolean description: Permite compartilhar contratos com qualquer contato do whatsapp ctrSer: type: boolean description: Permite alterar série para faturamento de contrato usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: rehabilitationHistory: description: Histórico de reabilitação type: object properties: id: type: string format: uuid description: Id da entidade agreementHeader: type: object allOf: – #/definitions/agreementHeader description: Contrato rehabilitationReason: type: object allOf: – #/definitions/e021mot description: Motivo da reabilitação rehabilitationNote: type: string description: Observação da reabilitação rehabilitationDate: type: string format: date-time description: Data e hora da reabilitação rehabilitationUser: type: string description: Usuário de reabilitação rehabilitationStatus: type: string allOf: – #/definitions/enumRehabilitationHistoryStatus description: Status da reabilitação errorMessage: type: string description: Mensagem de erro usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e020snf: description: Séries para faturamento do contrato type: object properties: id: type: string format: uuid description: Id da entidade e070fil: type: object allOf: – #/definitions/e070fil description: Filial codSnf: type: string maxLength: 3 description: Código abrSnf: type: string maxLength: 10 description: Abreviatura desSnf: type: string maxLength: 30 description: Descrição disAut: type: string allOf: – #/definitions/enumDisAut description: Dispositivo autorizado aplSnf: type: string allOf: – #/definitions/enumAplSnf description: Aplicação finSnf: type: string allOf: – #/definitions/enumFinSnf description: Finalidade codSel: type: string maxLength: 3 description: Série legal codSsl: type: string maxLength: 2 description: Série legal e032edc: type: object allOf: – #/definitions/e032edc description: Modelo do documento emiExt: type: boolean description: Série realiza emissão em sistema externo default: false excluido: type: boolean description: Indica se o registro foi excluído extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e032edc: description: Modelo de documento type: object properties: id: type: string format: uuid description: Id da entidade codEdc: type: string maxLength: 3 description: Modelo de documento desEdc: type: string maxLength: 30 description: Descrição abrEdc: type: string maxLength: 5 description: Abreviatura excluido: type: boolean description: Indica se o registro foi excluído extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070filComNfs: description: Filial comercial – Nota de Venda type: object properties: id: type: string format: uuid description: Id da entidade e070fil: type: object allOf: – #/definitions/e070fil description: Filial venSnp: type: object allOf: – #/definitions/e020snf description: Série padrão para nota fiscal de saída venSns: type: object allOf: – #/definitions/e020snf description: Série padrão para notas fiscais de serviço venSnr: type: object allOf: – #/definitions/e020snf description: Série padrão para notas fiscais de recibo de prestação de serviço excluido: type: boolean description: Indica se o registro foi excluído extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: billingHistory: description: Histórico de faturamento do contrato type: object properties: id: type: string format: uuid description: Id do histórico termInstallment: type: object allOf: – #/definitions/termInstallment description: Competência faturada usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: 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 description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE