Mais pesquisados:Customização, Tutorial, Documentação

guias_impostos

55 views 0 04/08/2020 Atualizado em 03/09/2024 integrador

2.0info: 6.2.0 guias_impostos description: Impostos – Guias x-senior-domain: erpx_cpl_imp x-senior-domain-path: erpx_cpl_imp x-senior-service-path: guias_impostos 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_cpl_impsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /guias_impostos/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviç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: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: 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 /guias_impostos/queries/calcularVencimentoGuia: post: description: Calcular vencimento da guia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dataBase – imposto – codigoArrecadacao properties: dataBase: type: string format: date description: Data Base para o Vencimento imposto: type: string allOf: – #/definitions/enumImpostosGuia description: Imposto codigoArrecadacao: type: string maxLength: 6 description: Código de Arrecadação regimeControleRetencao: type: string allOf: – #/definitions/enumRegimeControleRetencao description: Regime controle retencao filial: type: string description: Filial responses: 200: description: Ok schema: type: object required: – dtVencimento – fornecedor properties: dtVencimento: type: string format: date description: Data sugerida para vencimento fornecedor: type: object allOf: – #/definitions/e001pes description: Id do fornecedor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/queries/listarGuiasComErro: post: description: Lista as guias com erro paginada e com informações de empresa, filial e orgão de recolhimento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – offset – size properties: offset: type: integer format: int64 description: Controle de paginação e ordenação size: type: integer format: int64 description: Controle de paginação e ordenação orderby: type: string description: Ordenação responses: 200: description: Ok schema: type: object required: – guiasComErro – totalPages – totalElements properties: guiasComErro: type: array items: type: object allOf: – #/definitions/recGuiasComErro minimum: 1 description: Guias com erro totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Número total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista as guias com erro paginada e com informações de empresa, filial e orgão de recolhimento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Controle de paginação e ordenação in: query required: true type: integer format: int64 – name: size description: Controle de paginação e ordenação in: query required: true type: integer format: int64 – name: orderby description: Ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – guiasComErro – totalPages – totalElements properties: guiasComErro: type: array items: type: object allOf: – #/definitions/recGuiasComErro minimum: 1 description: Guias com erro totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Número total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/queries/permiteEstornarGuiaDocumento: post: description: Consulta a guia pelo id do documento e retorna se permite ou não tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documento properties: documento: type: string description: Id do documento tipoEstorno: type: string allOf: – #/definitions/enumAcaoEstorno description: Tipo de estorno responses: 200: description: Ok schema: type: object required: – permite properties: permite: type: boolean description: Indicativo se permite estornar mensagem: type: string description: Mensagem do porque não permite caso o indicativo anterior seja false 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/queries/obterGuiasSemPagamento: post: description: Consulta de guias sem pagamento por documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documento properties: documento: type: string description: Id do documento documentoGNRE: type: boolean description: Indicativo se deve buscar guias por documento GNRE default: false responses: 200: description: Ok schema: type: object required: – guiasNaoPagas properties: guiasNaoPagas: type: array items: type: object allOf: – #/definitions/recInformacoesGuia minimum: 1 description: Lista de guias sem pagamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta de guias sem pagamento por documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: documento description: Id do documento in: query required: true type: string – name: documentoGNRE description: Indicativo se deve buscar guias por documento GNRE in: query type: boolean responses: 200: description: Ok schema: type: object required: – guiasNaoPagas properties: guiasNaoPagas: type: array items: type: object allOf: – #/definitions/recInformacoesGuia minimum: 1 description: Lista de guias sem pagamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/queries/eligibleToExclude: post: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade in: query required: true type: string – name: id description: Id do registro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/queries/exportE002tpt: 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 /guias_impostos/queries/exportParametros: 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 /guias_impostos/queries/exportParametrosFinanceiros: 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 /guias_impostos/queries/exportGuias: 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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/queries/exportE025fer: 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 /guias_impostos/queries/exportGuiasComErro: 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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/queries/exportParametrosProdutos: 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 /guias_impostos/queries/exportDocumentoGuia: 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 /guias_impostos/queries/exportDocumentoGuiaParticipante: 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 /guias_impostos/queries/exportDocumentoGuiaItem: 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 /guias_impostos/queries/exportDocumentoGuiaItemImposto: 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 /guias_impostos/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 /guias_impostos/actions/gerarGuia: post: description: API para geração de guias tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentos properties: documentos: type: array items: type: object allOf: – #/definitions/informacaoOrigemGuia minimum: 1 description: Informações da origem da guia responses: 200: description: Ok schema: type: object required: – guias properties: guias: type: array items: type: object allOf: – #/definitions/recInformacaoGuiaGerada minimum: 1 description: Informações da origem da guia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/actions/reprocessarGuia: post: description: Reprocessar guia com erro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – documentos properties: id: type: string description: Id do erro da guia documentos: type: array items: type: object allOf: – #/definitions/informacaoOrigemGuia minimum: 1 description: Informações da guia a ser reprocessada tipoErro: type: string allOf: – #/definitions/enumTipoErroGuia description: Tipo de erro para guia responses: 200: description: Ok schema: type: object required: – guiasGeradas properties: guiasGeradas: type: array items: type: object allOf: – #/definitions/recInformacaoGuiaGerada minimum: 1 description: Informações da guia gerada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/actions/estornarGuiaDocumento: post: description: Estorna as guias pelo id do documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documento properties: documento: type: string description: Id do documento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/actions/notaFiscalIntegracaoGNRE: post: description: API DEPRECIADA: Substituído pelo evento notaFiscalFechada | DATA: 2023-10-31 | Primitiva para integração de guias gnre da nota fiscal de entrada tags: – Actions deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – identificador properties: identificador: type: string description: Identificador da nota fiscal chaveEletronica: type: string maxLength: 44 description: Chave eletrônica responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/actions/softExclude: post: description: Realiza a exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/actions/undoSoftExclude: post: description: Realiza a compensação da exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/actions/importE002tpt: 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 /guias_impostos/actions/importParametros: 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 /guias_impostos/actions/importParametrosFinanceiros: 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 /guias_impostos/actions/importGuias: 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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/actions/importE025fer: 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 /guias_impostos/actions/importGuiasComErro: 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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/actions/importParametrosProdutos: 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 /guias_impostos/actions/importDocumentoGuia: 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 /guias_impostos/actions/importDocumentoGuiaParticipante: 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 /guias_impostos/actions/importDocumentoGuiaItem: 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 /guias_impostos/actions/importDocumentoGuiaItemImposto: 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 /guias_impostos/signals/estornarGuiaDocumentoAsync: post: description: Estorna as guias pelo id do documento tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – documento – tipoEstorno properties: transactionaIId: type: string description: TransactionalId documento: type: string description: Id do documento tipoEstorno: type: string allOf: – #/definitions/enumAcaoEstorno description: Tipo de estorno responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /guias_impostos/events/excluirProdutosParametro: post: description: Evento para exclusão dos produtos relacionados a um parâmetro de guia de recolhimento x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – parametroGuiaId properties: parametroGuiaId: type: string description: UUID do parâmetro da guia de recolhimento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /guias_impostos/events/estornarGuiaDocumentoSucesso: post: description: Evento estorno da guias do documento realizado com sucesso x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – documento properties: transactionaIId: type: string description: TransactionalId documento: type: string description: Id do documento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /guias_impostos/events/estornarGuiaDocumentoErro: post: description: Evento de erro no estorno da guias do documento x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – documento properties: transactionaIId: type: string description: TransactionalId documento: type: string description: Id do documento msgErro: type: string description: Mensagem do erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /guias_impostos/events/guiaRecolhimentoGerada: post: description: Evento de guia de recolhimento gerada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – guias properties: guias: type: array items: type: object allOf: – #/definitions/recInformacaoGuiaGerada minimum: 1 description: Informações das guias de recolhimento geradas responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /guias_impostos/events/guiaRecolhimentoExcluida: post: description: Evento de guia de recolhimento excluída x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – guias properties: guias: type: array items: type: string minimum: 1 description: Identificadores das guias de recolhimento excluídas responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /guias_impostos/events/guiaRecolhimentoCancelada: post: description: Evento de guia de recolhimento cancelada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – guia – transacaoCancelamentoId – dataCancelamento properties: guia: type: object allOf: – #/definitions/recInformacaoGuiaGerada description: Informações da guia cancelada transacaoCancelamentoId: type: string description: Identificador da transação de cancelamento dataCancelamento: type: string format: date description: Data de cancelamento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /guias_impostos/events/alterarStatusLoteGuiaSucesso: post: description: Evento para alterar status do lote financeiro para sucesso x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – documento properties: documento: type: string description: Id do documento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /guias_impostos/events/alterarStatusLoteGuiaErro: post: description: Evento para alterar status do lote financeiro para erro x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – documento properties: documento: type: string description: Id do documento msgErro: type: string description: Mensagem do erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/events/importE002tptEvent: 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 /guias_impostos/events/exportE002tptEvent: 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 /guias_impostos/events/importParametrosEvent: 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 /guias_impostos/events/exportParametrosEvent: 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 /guias_impostos/events/importParametrosFinanceirosEvent: 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 /guias_impostos/events/exportParametrosFinanceirosEvent: 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 /guias_impostos/events/importGuiasEvent: 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 /guias_impostos/events/exportGuiasEvent: 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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/events/importE025ferEvent: 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 /guias_impostos/events/exportE025ferEvent: 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 /guias_impostos/events/importGuiasComErroEvent: 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 /guias_impostos/events/exportGuiasComErroEvent: 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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/events/importParametrosProdutosEvent: 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 /guias_impostos/events/exportParametrosProdutosEvent: 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 /guias_impostos/events/importDocumentoGuiaEvent: 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 /guias_impostos/events/exportDocumentoGuiaEvent: 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 /guias_impostos/events/importDocumentoGuiaParticipanteEvent: 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 /guias_impostos/events/exportDocumentoGuiaParticipanteEvent: 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 /guias_impostos/events/importDocumentoGuiaItemEvent: 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 /guias_impostos/events/exportDocumentoGuiaItemEvent: 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 /guias_impostos/events/importDocumentoGuiaItemImpostoEvent: 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 /guias_impostos/events/exportDocumentoGuiaItemImpostoEvent: 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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/entities/e002tpt: 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/e002tpt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/e002tpt/{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/e002tpt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/parametros: 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/parametros responses: 200: description: The created resource schema: #/definitions/parametros 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/parametros responses: 200: description: The created resource schema: #/definitions/parametros 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/parametros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/parametros/{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/parametros responses: 200: description: Ok schema: #/definitions/parametros 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/parametros responses: 200: description: Ok schema: #/definitions/parametros 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/parametros 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 /guias_impostos/entities/parametros/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/parametros responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/parametrosFinanceiros: 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/parametrosFinanceiros responses: 200: description: The created resource schema: #/definitions/parametrosFinanceiros 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/parametrosFinanceiros responses: 200: description: The created resource schema: #/definitions/parametrosFinanceiros 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/parametrosFinanceiros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/parametrosFinanceiros/{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/parametrosFinanceiros responses: 200: description: Ok schema: #/definitions/parametrosFinanceiros 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/parametrosFinanceiros responses: 200: description: Ok schema: #/definitions/parametrosFinanceiros 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/parametrosFinanceiros 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 /guias_impostos/entities/parametrosFinanceiros/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/parametrosFinanceiros responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/guias: 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/guias responses: 200: description: The created resource schema: #/definitions/guias 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/guias responses: 200: description: The created resource schema: #/definitions/guias 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/guias 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/guias/{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/guias responses: 200: description: Ok schema: #/definitions/guias 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/guias responses: 200: description: Ok schema: #/definitions/guias 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/guias 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 /guias_impostos/entities/guias/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/guias responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/entities/e025fer: 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/e025fer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/e025fer/{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/e025fer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/guiasComErro: 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/guiasComErro responses: 200: description: The created resource schema: #/definitions/guiasComErro 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/guiasComErro responses: 200: description: The created resource schema: #/definitions/guiasComErro 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/guiasComErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/guiasComErro/{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/guiasComErro responses: 200: description: Ok schema: #/definitions/guiasComErro 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/guiasComErro responses: 200: description: Ok schema: #/definitions/guiasComErro 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/guiasComErro 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 /guias_impostos/entities/guiasComErro/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/guiasComErro responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/entities/parametrosProdutos: 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/parametrosProdutos responses: 200: description: The created resource schema: #/definitions/parametrosProdutos 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/parametrosProdutos responses: 200: description: The created resource schema: #/definitions/parametrosProdutos 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/parametrosProdutos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/parametrosProdutos/{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/parametrosProdutos responses: 200: description: Ok schema: #/definitions/parametrosProdutos 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/parametrosProdutos responses: 200: description: Ok schema: #/definitions/parametrosProdutos 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/parametrosProdutos 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 /guias_impostos/entities/parametrosProdutos/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/parametrosProdutos responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/documentoGuia: 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/documentoGuia responses: 200: description: The created resource schema: #/definitions/documentoGuia 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/documentoGuia responses: 200: description: The created resource schema: #/definitions/documentoGuia 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/documentoGuia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/documentoGuia/{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/documentoGuia responses: 200: description: Ok schema: #/definitions/documentoGuia 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/documentoGuia responses: 200: description: Ok schema: #/definitions/documentoGuia 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/documentoGuia 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 /guias_impostos/entities/documentoGuia/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentoGuia responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/documentoGuiaParticipante: 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/documentoGuiaParticipante responses: 200: description: The created resource schema: #/definitions/documentoGuiaParticipante 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/documentoGuiaParticipante responses: 200: description: The created resource schema: #/definitions/documentoGuiaParticipante 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/documentoGuiaParticipante 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/documentoGuiaParticipante/{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/documentoGuiaParticipante responses: 200: description: Ok schema: #/definitions/documentoGuiaParticipante 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/documentoGuiaParticipante responses: 200: description: Ok schema: #/definitions/documentoGuiaParticipante 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/documentoGuiaParticipante 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 /guias_impostos/entities/documentoGuia/{parentId}/participantes: 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/documentoGuiaParticipante responses: 200: description: The created resources schema: type: array items: #/definitions/documentoGuiaParticipante 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/documentoGuiaParticipante responses: 200: description: The created resources schema: type: array items: #/definitions/documentoGuiaParticipante 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/documentoGuiaParticipante 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/documentoGuia/{parentId}/participantes/{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/documentoGuiaParticipante responses: 200: description: Ok schema: #/definitions/documentoGuiaParticipante 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/documentoGuiaParticipante responses: 200: description: Ok schema: #/definitions/documentoGuiaParticipante 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/documentoGuiaParticipante 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 /guias_impostos/entities/documentoGuiaParticipante/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentoGuiaParticipante responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/documentoGuiaItem: 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/documentoGuiaItem responses: 200: description: The created resource schema: #/definitions/documentoGuiaItem 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/documentoGuiaItem responses: 200: description: The created resource schema: #/definitions/documentoGuiaItem 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/documentoGuiaItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/documentoGuiaItem/{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/documentoGuiaItem responses: 200: description: Ok schema: #/definitions/documentoGuiaItem 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/documentoGuiaItem responses: 200: description: Ok schema: #/definitions/documentoGuiaItem 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/documentoGuiaItem 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 /guias_impostos/entities/documentoGuia/{parentId}/itens: 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/documentoGuiaItem responses: 200: description: The created resources schema: type: array items: #/definitions/documentoGuiaItem 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/documentoGuiaItem responses: 200: description: The created resources schema: type: array items: #/definitions/documentoGuiaItem 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/documentoGuiaItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/documentoGuia/{parentId}/itens/{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/documentoGuiaItem responses: 200: description: Ok schema: #/definitions/documentoGuiaItem 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/documentoGuiaItem responses: 200: description: Ok schema: #/definitions/documentoGuiaItem 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/documentoGuiaItem 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 /guias_impostos/entities/documentoGuiaItem/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentoGuiaItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/documentoGuiaItemImposto: 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/documentoGuiaItemImposto responses: 200: description: The created resource schema: #/definitions/documentoGuiaItemImposto 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/documentoGuiaItemImposto responses: 200: description: The created resource schema: #/definitions/documentoGuiaItemImposto 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/documentoGuiaItemImposto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/documentoGuiaItemImposto/{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/documentoGuiaItemImposto responses: 200: description: Ok schema: #/definitions/documentoGuiaItemImposto 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/documentoGuiaItemImposto responses: 200: description: Ok schema: #/definitions/documentoGuiaItemImposto 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/documentoGuiaItemImposto 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 /guias_impostos/entities/documentoGuiaItem/{parentId}/impostos: 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/documentoGuiaItemImposto responses: 200: description: The created resources schema: type: array items: #/definitions/documentoGuiaItemImposto 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/documentoGuiaItemImposto responses: 200: description: The created resources schema: type: array items: #/definitions/documentoGuiaItemImposto 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/documentoGuiaItemImposto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/documentoGuiaItem/{parentId}/impostos/{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/documentoGuiaItemImposto responses: 200: description: Ok schema: #/definitions/documentoGuiaItemImposto 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/documentoGuiaItemImposto responses: 200: description: Ok schema: #/definitions/documentoGuiaItemImposto 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/documentoGuiaItemImposto 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 /guias_impostos/entities/documentoGuiaItemImposto/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentoGuiaItemImposto responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: description: Up or down type: string enum: – UP – DOWN enumAcaoEstorno: description: Enum para ação de estorno type: string enum: – CANCELAMENTO – REABILITACAO enumRegimeControleRetencao: description: Regime controle retenção type: string enum: – COMPETENCIA – CAIXA enumTipoErroGuia: description: Tipo de erro para guia type: string enum: – ERRO_IMPOSTO – ERRO_INFORMACOES_INCOMPLETAS – ERRO_PARAMETRIZACAO – ERRO_GNRE – ERRO – ERRO_FINANCEIRO enumOrigemGuia: description: Origem da guia type: string enum: – NF_SAIDA – NF_ENTRADA – FINANCEIRO_CP – MANUAL enumLisMod: description: Módulo da transação type: string enum: – VVEP – VVEF – VVES – VESN – VESR – VESB – VCRE – VCRP – VCRB – VCOO – VCOF – VCOS – VCPE – VCPP – VCPB – VCPM – VCBC – VCBM – VPAT enumJurFis: description: Tipo de pessoa type: string enum: – VJ – VF enumSituacaoGuia: description: Situacao da Guia type: string enum: – GERADA – AGUARDANDO_PAGAMENTO – AGUARDANDO_GERACAO_TITULO – AGUARDANDO_CANCELAMENTO_FINANCEIRO – AGUARDANDO_ATUALIZACAO_FINANCEIRO_CANCELAMENTO – AGUARDANDO_ATUALIZACAO_FINANCEIRO_GERACAO_TITULO – CANCELADA – PAGA – ERRO_TITULO – ERRO_AO_CANCELAR_TITULO – ERRO_AO_ATUALIZAR_TITULO_CANCELAMENTO – ERRO_AO_ATUALIZAR_TITULO_GERACAO – AGUARDANDO_GERACAO_GNRE – GNRE_COM_ERRO – GNRE_GERADA enumSitReg: description: Situação do registro type: string enum: – VA – VI enumFatoGeradorVencimento: description: Fato gerador do Vencimento type: string enum: – EMISSAO – ENTRADA – CONTRATACAO_CAMBIO – ULTIMO_DIA_MES_DATA_EMISSAO – ULTIMO_DIA_MES_DATA_ENTRADA – ULTIMO_DIA_MES_DATA_BASE_FINANCEIRA – DATA_BASE_FINANCEIRA enumSituacao: description: Situação type: string enum: – VATIVO – VINATIVO enumTipoVencimento: description: Tipo do Vencimento type: string enum: – ANTECIPA – MANTEM – POSTERGA enumImpostosGuia: description: Impostos guia type: string enum: – CSRF – IRRF – INSS – ISS – FCP – DIFAL – ICMS_ST – FCP_ST – FUNRURAL_TOTAL – FUNRURAL_INSS – FUNRURAL_SENAR – FUNRURAL_RAT enumIntegracaoFinanceira: description: Situação da integração com o finanças type: string enum: – NAO_INTEGRADO – TITULO_GERADO – TITULO_GERADO_CONTABILIZADO – TITULO_PAGO – TITULO_CANCELADO enumVersaoXMLGNRE: description: Versão do XML GNRE type: string enum: – NAO_GERA – V2_00 enumSituacaoDocumentoGuia: description: Enumeração situação geração da guia type: string enum: – NAO_INICIADO – NAO_GERA_GUIA – GERACAO_GUIA_INICIADO – ERRO_AO_GERAR_GUIA – GUIA_GERADA_COM_SUCESSO – EM_PROCESSAMENTO enumTipoParticipanteGuia: description: Enumeração com o tipo de endereço relacionado à entidade documento guia endereço type: string enum: – EMITENTE – DESTINATARIO 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 informacaoOrigemGuia: description: Informações da origem da guia type: object required: – origem – documento – documentoDescricao properties: origem: type: string allOf: – #/definitions/enumOrigemGuia description: Origem documento: type: string description: Id do documento documentoDescricao: type: string description: Descrição do documento informacoesAdicionais: type: object allOf: – #/definitions/recInformacoesAdicionais description: Informações complementares a geração da origem para geração da guia guias: type: array items: type: object allOf: – #/definitions/guiaRecolhimento description: Informações das guia geradas recInformacoesAdicionais: description: Informações adicionar para geração da guia (utilizado para integração com o finanças) type: object required: – empresa properties: empresa: type: string description: Identificador da empresa gerouParcelaFinanceira: type: boolean description: Quando o documento é origem NF_ENTRADA/SAÍDA, deve ser indicado se o documento gerou parcelas financeira para podermos incluirmos no mesmo lote financeiro fatoContabil: type: object allOf: – #/definitions/recFatoContabil description: Fato contábil controlProcess: type: string description: Identificador de controle de processo recInformacaoGuiaGerada: description: Informações da origem da guia gerada type: object required: – origem – documento – documentoDescricao – guias properties: origem: type: string allOf: – #/definitions/enumOrigemGuia description: Origem documento: type: string description: Id do documento documentoDescricao: type: string description: Descrição do documento informacoesAdicionais: type: object allOf: – #/definitions/recInformacoesAdicionais description: Informações complementares a geração da origem para geração da guia guias: type: array items: type: object allOf: – #/definitions/recGuiaRecolhimentoGerada minimum: 1 description: Informações das guia geradas guiaRecolhimento: description: Informações para geração da guia de recolhimento type: object required: – filial – imposto – valor – codigoArrecadacao properties: filial: type: string description: Id da filial municipio: type: string description: Código IBGE do município dataEmissao: type: string format: date description: Data de emissão dataEntrada: type: string format: date description: Data de entrada dataBaseFinanceira: type: string format: date description: Data base financeiro dataCambio: type: string format: date description: Data da contratação do câmbio dataPagamento: type: string format: date description: Data de pagamento vencimento: type: string format: date description: Vencimento imposto: type: string allOf: – #/definitions/enumImpostosGuia description: Tipo de imposto valor: type: string description: Valor minimum: 0.00 codigoArrecadacao: type: string description: Código de arrecadação orgaoRecolhimento: type: string description: Orgão de recolhimento regimeControleRetencao: type: string allOf: – #/definitions/enumRegimeControleRetencao description: Regime controle retencao parametroGuiaId: type: string description: Parametro de guia que deve ser utilizado na busca das informações para geração da guia codigoProdutoGNRE: type: integer format: int64 description: Código produto GNRE guiaId: type: string description: Id da guia recGuiaRecolhimentoGerada: description: Informações das guias geradas type: object required: – filial – dataEmissao – vencimento – orgaoRecolhimento – tipoTitulo – transacao – guia – documento – valor – imposto properties: filial: type: string description: Id da filial dataEmissao: type: string format: date description: Data de emissão vencimento: type: string format: date description: Data de vencimento orgaoRecolhimento: type: string description: Id do Orgão de Recolhimento tipoTitulo: type: string description: Id do tipo de título transacao: type: string description: Id da transação guia: type: string description: Id da guia documento: type: string description: Id do documento valor: type: string description: Valor multa: type: string description: Multa da guia juros: type: string description: Juros da guia imposto: type: string allOf: – #/definitions/enumImpostosGuia description: Tipo de imposto regimeControleRetencao: type: string allOf: – #/definitions/enumRegimeControleRetencao description: Regime controle retencao codigoDeBarras: type: string description: Código de barras parametroGuiaId: type: string description: Identificador do parâmetro utilizado na geração da guia gerarGNRE: type: boolean description: Informativo de a guia deve gerar GNRE default: false codigoProdutoGNRE: type: integer format: int64 description: Código de produto GNRE guiaId: type: string description: Id da guia recFatoContabil: description: Informações do fato contábil type: object properties: fatoContabilId: type: string description: Identificador descricaoFatoContabil: type: string description: Descrição recGuiasComErro: description: Informações das guias com erro type: object required: – json – erro – reprocessable – dthger – usuger – documentos properties: id: type: string description: Id da entidade json: type: string description: JSON da guia com Erro erro: type: string allOf: – #/definitions/enumTipoErroGuia description: Impostos com erro reprocessable: type: boolean description: Indicativo se é possível reprocessar a Guia dthger: type: string format: date-time description: data de geração usuger: type: string description: Usuário de geração documentos: type: array items: type: object allOf: – #/definitions/informacaoGuiaComErro minimum: 1 description: Informações dos documentos recInfoEntidade: description: Record com informações gerais de entidade type: object properties: id: type: string description: Identificador da entidade codigo: type: string description: Código da entidade descricao: type: string description: Descricão da entidade label: type: string description: Label (código + descrição) recInformacoesGuia: description: Record com informações da guia type: object required: – guiaId – empresa – filial – dataEmissao – vencimento – orgaoRecolhimento – tipoTitulo – codigoArrecadacao – documento – documentoDescricao – valor – imposto properties: guiaId: type: string description: Id da guia empresa: type: object allOf: – #/definitions/recInfoEntidade description: Informações da empresa filial: type: object allOf: – #/definitions/recInfoEntidade description: Informações da filial dataEmissao: type: string format: date description: Data de emissão vencimento: type: string format: date description: Data de vencimento orgaoRecolhimento: type: object allOf: – #/definitions/recInfoEntidade description: Orgão de Recolhimento tipoTitulo: type: object allOf: – #/definitions/recInfoEntidade description: Tipo de título codigoArrecadacao: type: string description: Código de arrecadação documento: type: string description: Id do documento documentoDescricao: type: string description: Descricao do documento valor: type: string description: Valor multa: type: string description: Multa da guia valorTotal: type: string description: Valor total juros: type: string description: Juros da guia imposto: type: string allOf: – #/definitions/enumImpostosGuia description: Tipo de imposto codigoProdutoGNRE: type: integer format: int64 description: Código de produto GNRE informacaoGuiaComErro: description: Informações da origem da guia type: object properties: origem: type: string allOf: – #/definitions/enumOrigemGuia description: Origem documentoDescricao: type: string description: Descrição do documento informacoesAdicionais: type: object allOf: – #/definitions/recInformacoesAdicionaisGuiasComErro description: Informações complementares a geração da origem para geração da guia guias: type: array items: type: object allOf: – #/definitions/guiaComErro description: Informações das guia que estão com erro recInformacoesAdicionaisGuiasComErro: description: Informações adicionar para geração da guia (utilizado para integração com o finanças) type: object properties: empresa: type: string description: Identificador da empresa codEmp: type: integer format: int64 description: Código da empresa nomEmp: type: string description: Nome da empresa guiaComErro: description: Informações da guia com erro type: object required: – imposto – valor – codigoArrecadacao – erro properties: filial: type: string description: Id da filial codFil: type: integer format: int64 description: Filial nomFil: type: string description: Nome dataEmissao: type: string format: date description: Data de emissão dataEntrada: type: string format: date description: Data de entrada dataPagamento: type: string format: date description: Data de pagamento imposto: type: string allOf: – #/definitions/enumImpostosGuia description: Tipo de imposto valor: type: string description: Valor minimum: 0.00 codigoArrecadacao: type: string description: Código de arrecadação orgaoRecolhimento: type: string description: Id do Orgão de recolhimento codPes: type: integer format: int64 description: Código do orgão de recolhimento nomPes: type: string description: Nome do orgão de recolhimento regimeControleRetencao: type: string allOf: – #/definitions/enumRegimeControleRetencao description: Regime controle retencao erro: type: string description: Mensagem do erro codigoProduto: type: string description: Código do produto uf: type: string description: UF parametroGuiaId: type: string description: Identificador do parâmetro utilizado na geração da guia guiaGNRE: type: boolean description: Inficativo se é uma guia GNRE default: false guiaId: type: string description: Id da guia codigoParametroGuia: type: string description: Código do parâmetro utilizado na geração da guia recItemEvento: description: Record utilizado nos eventos da nota type: object required: – item – quantidadeRecebida – quantidadeUnidadeEstoque – unidadeCompra – idOrigem properties: item: type: string description: Itentificador do item da nota fiscal quantidadeRecebida: type: number format: double description: Quantidade recebida quantidadeUnidadeEstoque: type: number format: double description: Quantidade na unidade de armazenamento unidadeCompra: type: string description: Unidade de medida de compra idOrigem: type: string description: Identificador do item de origem e001pes: description: Pessoa type: object properties: id: type: string format: uuid description: Id da entidade codPes: type: integer format: int64 description: Código minimum: 0 maximum: 999999999 nomPes: type: string maxLength: 100 description: Nome tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa sitPes: type: string allOf: – #/definitions/enumSitReg description: Situação cnpCpf: type: string maxLength: 14 description: CNPJ/CPF numIdf: type: string maxLength: 40 description: Número de identificação fiscal (NIF) 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 cxaPst: type: integer format: int64 description: Caixa postal minimum: 0 maximum: 999999 zipCod: type: string maxLength: 20 description: Zip code excluido: type: boolean description: Indica se o registro foi excluído 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: e006pai: description: País type: object 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 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: e008rai: description: Cidade type: object properties: id: type: string format: uuid description: Id da entidade codRai: type: integer format: int64 description: Código cidade minimum: 0 maximum: 9999999 nomCid: type: string maxLength: 60 description: Nome cidade e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado codIbg: type: integer format: int64 description: Código IBGE município minimum: 0 maximum: 9999999 cepMin: type: integer format: int64 description: CEP inicial minimum: 0 maximum: 99999999 cepMax: type: integer format: int64 description: CEP final minimum: 0 maximum: 99999999 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: e007ufs: description: Estado type: object properties: id: type: string format: uuid description: Id da entidade sigUfs: type: string maxLength: 2 description: Sigla nomUfs: type: string maxLength: 20 description: Nome e006pai: type: object allOf: – #/definitions/e006pai description: País excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string 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: e002tpt: description: Tipo de título type: object properties: id: type: string format: uuid description: Id da entidade codTpt: type: string maxLength: 3 description: Tipo de título desTpt: type: string maxLength: 40 description: Descrição do tipo de título 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: parametros: description: Parâmetros para geração da guia type: object required: – codigo – imposto – codigoArrecadacao – fatoGeradorDoVencimento – diasParaVencimento – tipoVencimento – fornecedor – regimeControleRetencao – versaoXMLGNRE properties: id: type: string format: uuid description: Id da entidade codigo: type: string maxLength: 10 description: Código de negócio imposto: type: string allOf: – #/definitions/enumImpostosGuia description: Imposto codigoArrecadacao: type: string maxLength: 6 description: Código de Arrecadação uf: type: object allOf: – #/definitions/e007ufs description: UF cidade: type: object allOf: – #/definitions/e008rai description: Cidade fatoGeradorDoVencimento: type: string allOf: – #/definitions/enumFatoGeradorVencimento description: Fato gerado para o Vencimento diasParaVencimento: type: integer format: int64 description: Quantidade de dias para o vencimento minimum: 0 maximum: 999 tipoVencimento: type: string allOf: – #/definitions/enumTipoVencimento description: Tipo de vencimento fornecedor: type: object allOf: – #/definitions/e001pes description: Fornecedor regimeControleRetencao: type: string allOf: – #/definitions/enumRegimeControleRetencao description: Regime controle retenção codigoDetalhamentoReceita: type: integer format: int64 description: Código do detalhamento da receita minimum: 0 maximum: 999999 versaoXMLGNRE: type: string allOf: – #/definitions/enumVersaoXMLGNRE description: Versão do xml da GNRE excluido: type: boolean description: Sinaliza se o registro foi excluido default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: parametrosFinanceiros: description: Parâmetros financeiros type: object required: – parametros – filial properties: id: type: string format: uuid description: Id da entidade parametros: type: object allOf: – #/definitions/parametros description: Parametro relacionado filial: type: object allOf: – #/definitions/e070fil description: Filial tipoTitulo: type: object allOf: – #/definitions/e002tpt description: Tipo de título transacaoFinanceira: type: object allOf: – #/definitions/e001tns description: Transação financeira transacaoCancelamento: type: object allOf: – #/definitions/e001tns description: Transação cancelamento excluido: type: boolean description: Sinaliza se o registro foi excluido default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: guias: description: Guias type: object required: – filial – documentoDescricao – dataBase – origem – imposto – vencimento – fornecedor – situacao – valor – valorTotal – codigoArrecadacao properties: id: type: string format: uuid description: Id da entidade filial: type: object allOf: – #/definitions/e070fil description: Filial documento: type: string maxLength: 255 description: Identificação do Documento documentoDescricao: type: string maxLength: 510 description: Descritivo para o Documento dataBase: type: string format: date description: Data Base para o Vencimento origem: type: string allOf: – #/definitions/enumOrigemGuia description: Origem do documento imposto: type: string allOf: – #/definitions/enumImpostosGuia description: Imposto vencimento: type: string format: date description: Vencimento fornecedor: type: object allOf: – #/definitions/e001pes description: Fornecedor tipoTitulo: type: object allOf: – #/definitions/e002tpt description: Tipo de título transacao: type: object allOf: – #/definitions/e001tns description: Transação situacao: type: string allOf: – #/definitions/enumSituacaoGuia description: Situação da Guia descricao: type: string maxLength: 250 description: Descrição valor: type: string description: Valor minimum: 0.00 maximum: 99999999.99 dataPagamento: type: string format: date description: Data de Pagamento valorMulta: type: string description: Valor da Multa minimum: 0.00 maximum: 99999999.99 valorJurosOutrosEncargos: type: string description: Valor Juros e outros encargos minimum: 0.00 maximum: 99999999.99 valorTotal: type: string description: Valor total minimum: 0.00 maximum: 99999999.99 codigoArrecadacao: type: string maxLength: 255 description: Còdigo de Arrecadação codigoDeBarras: type: string maxLength: 255 description: Código de Barras excluido: type: boolean description: Sinaliza se o registro foi excluido default: false integracaoFinanceira: type: string allOf: – #/definitions/enumIntegracaoFinanceira description: Indicativo da situação atual da guia com o finanças guiaGNRE: type: boolean description: Inficativo se é uma guia GNRE default: false parametro: type: object allOf: – #/definitions/parametros description: Parametro utilizado na geração da guia codigoProdutoGNRE: type: integer format: int64 description: Código do produto GNRE uf: type: object allOf: – #/definitions/e007ufs description: UF da guia usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070emp: description: Cadastros – Empresas type: object required: – codEmp – nomEmp 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 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: e070fil: description: Filial type: object 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 numCgc: type: string maxLength: 18 description: CPF/CNPJ numIdf: type: string maxLength: 40 description: Número identificação fiscal e008rai: type: object allOf: – #/definitions/e008rai description: Cidade 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: e001tns: description: Transação type: object 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 desTns: type: string maxLength: 60 description: Descrição lisMod: type: string allOf: – #/definitions/enumLisMod description: Módulo sitTns: 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: e025fer: description: Feriado type: object required: – diaFer – mesFer – anoFer – desFer – excluido properties: id: type: string format: uuid description: Id da entidade diaFer: type: integer format: int64 description: Dia do feriado minimum: 0 maximum: 99 mesFer: type: integer format: int64 description: Mês do feriado minimum: 0 maximum: 99 anoFer: type: integer format: int64 description: Ano do feriado minimum: 0 maximum: 9999 e006pai: type: object allOf: – #/definitions/e006pai description: País e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado e008rai: type: object allOf: – #/definitions/e008rai description: Cidade desFer: type: string maxLength: 30 description: Descrição ferBan: type: boolean description: É apenas feriado bancário excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: guiasComErro: description: Guias que entraram com ERRO type: object required: – json – erro – reprocessable properties: id: type: string format: uuid description: Id da entidade json: type: string description: JSON da guia com Erro erro: type: string allOf: – #/definitions/enumTipoErroGuia description: Mensagem de erro reprocessable: type: boolean description: Indicativo se é possível reprocessar a Guia documento: type: string description: Id do documento guiaGNRE: type: boolean description: Indicativo de erro de guias GNRE default: false 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: – id – codDer – e070emp – sitDer properties: id: type: string format: uuid description: Id da entidade codDer: type: string maxLength: 23 description: Derivação e070emp: type: object allOf: – #/definitions/e070emp description: Empresa desDer: type: string maxLength: 120 description: Descrição sitDer: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false 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 – Produtos – Derivações type: object required: – id – codSer – e070emp – sitSer properties: id: type: string format: uuid description: Id da entidade codSer: type: string maxLength: 23 description: Derivação e070emp: type: object allOf: – #/definitions/e070emp description: Empresa desSer: type: string maxLength: 120 description: Descrição sitSer: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: parametrosProdutos: description: Parâmetros produtos type: object required: – parametros – produto – status properties: id: type: string format: uuid description: Id da entidade parametros: type: object allOf: – #/definitions/parametros description: Parametro relacionado produto: type: object allOf: – #/definitions/e075der description: Produto codigoProduto: type: integer format: int64 description: Código do produto para GNRE minimum: 0 maximum: 99999 descricaoProduto: type: string maxLength: 255 description: Descrição do produto para GNRE status: type: string allOf: – #/definitions/enumSituacao description: Status – ativo/inativo usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: documentoGuia: description: Documentos que precisam gerar guia de impostos (GNRE) type: object required: – origem – situacao – message properties: id: type: string format: uuid description: Id da entidade origem: type: string allOf: – #/definitions/enumOrigemGuia description: Origem do documento documento: type: string description: Identificação do documento filial: type: object allOf: – #/definitions/e070fil description: Filial do documento descricaoDocumento: type: string maxLength: 255 description: Descritivo para o documento situacao: type: string allOf: – #/definitions/enumSituacaoDocumentoGuia description: Situação do documento em relação a geração da guia tipoDocumento: type: string maxLength: 255 description: Tipo de documento message: type: string description: Dados do payload do evento que originou a guia complementoSituacao: type: string description: Complemento da situação chaveEletronica: type: string description: Chave eletrônica do documento dataEmissao: type: string format: date-time description: Data de emissão dataEntrada: type: string format: date-time description: Data de entrada participantes: type: array items: type: object allOf: – #/definitions/documentoGuiaParticipante description: Informações de endereço do emitente e destinatário itens: type: array items: type: object allOf: – #/definitions/documentoGuiaItem description: Itens do documento modeloDocumento: type: string maxLength: 3 description: Modelo de documento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: documentoGuiaParticipante: description: Endreços da documentoGuia type: object required: – participanteId – tipoParticipante properties: id: type: string format: uuid description: Id da entidade participanteId: type: string format: uuid description: Id do participante documentoGuia: type: object allOf: – #/definitions/documentoGuia description: Documento Guia tipoParticipante: type: string allOf: – #/definitions/enumTipoParticipanteGuia description: Tipo do endereço endereco: type: string maxLength: 250 description: Endereço numero: type: string maxLength: 60 description: Número complemento: type: string maxLength: 255 description: Complemento cep: type: string maxLength: 20 description: CEP cidade: type: string description: Cidade uf: type: string maxLength: 2 description: Sigla da Unidade federativa(UF) razaoSocial: type: string description: Razão social ieUfDestino: type: string description: Inscrição estadual do emitente na uf de destino cpf: type: string description: CPF cnpj: type: string description: CNPJ usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: documentoGuiaItem: description: Item documento guia type: object properties: id: type: string format: uuid description: Id da entidade documentoGuia: type: object allOf: – #/definitions/documentoGuia description: Documento Guia itemDocumentoId: type: string format: uuid description: Identificador do item do documento produto: type: object allOf: – #/definitions/e075der description: Produto servico: type: object allOf: – #/definitions/e080ser description: Serviço impostos: type: array items: type: object allOf: – #/definitions/documentoGuiaItemImposto description: Impostos do item do documento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: documentoGuiaItemImposto: description: Imposto Item documento guia type: object required: – imposto – valor properties: id: type: string format: uuid description: Id da entidade documentoGuiaItem: type: object allOf: – #/definitions/documentoGuiaItem description: Item documento guia imposto: type: string allOf: – #/definitions/enumImpostosGuia description: Imposto valor: type: string description: Valor minimum: 0.00 maximum: 99999999.99 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

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação