retencoes

2.0info: 1.5.0 retencoes description: Serviço que gerencia o saldo das retenções dos impostos x-senior-domain: erpx_cpl x-senior-domain-path: erpx_cpl x-senior-service-path: retencoes contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erpx_cplsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /retencoes/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 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 default: description: Error response schema: #/definitions/genericError /retencoes/queries/calculaRetencoes: post: description: Cálculo de retenções tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – informacaoDocumento properties: informacaoDocumento: type: object allOf: – #/definitions/informacaoDocumento description: Informações do documento responses: 200: description: Ok schema: type: object required: – retornoCalculo properties: retornoCalculo: type: object allOf: – #/definitions/retornoCalculo description: Retorno dos calculos da retenção default: description: Error response schema: #/definitions/genericError /retencoes/queries/calculaRetencoesBatch: post: description: Cálculo de retenção de vários documentos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – informacoesDocumentos properties: informacoesDocumentos: type: array items: type: object allOf: – #/definitions/informacaoDocumento minimum: 1 description: Informações do documento responses: 200: description: Ok schema: type: object required: – retornoCalculo properties: retornoCalculo: type: array items: type: object allOf: – #/definitions/retornoCalculo minimum: 1 description: Retorno dos calculos da retenção default: description: Error response schema: #/definitions/genericError /retencoes/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: 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: default: description: Error response schema: #/definitions/genericError /retencoes/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /retencoes/queries/exportE070fil: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /retencoes/queries/exportE001pes: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /retencoes/queries/exportSaldoCsrf: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /retencoes/queries/exportSaldoIrrf: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /retencoes/queries/exportSaldoIss: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /retencoes/queries/exportSaldoInss: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /retencoes/queries/exportSaldoInssPatronal: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /retencoes/queries/exportSaldoProgressivoIrrf: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /retencoes/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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 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: PUBLIC 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 default: description: Error response schema: #/definitions/genericError /retencoes/actions/estornarRetencoesDocumento: post: description: Estorna as retenções do documento informado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – informacaoDocumento properties: informacaoDocumento: type: object allOf: – #/definitions/informacaoDocumento description: Informações do documento responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /retencoes/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response default: description: Error response schema: #/definitions/genericError /retencoes/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /retencoes/actions/importE070fil: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /retencoes/actions/importE001pes: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /retencoes/actions/importSaldoCsrf: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /retencoes/actions/importSaldoIrrf: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /retencoes/actions/importSaldoIss: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /retencoes/actions/importSaldoInss: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /retencoes/actions/importSaldoInssPatronal: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /retencoes/actions/importSaldoProgressivoIrrf: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /retencoes/entities/e070emp: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/e070emp default: description: Error response schema: #/definitions/genericError /retencoes/entities/e070emp/{id}: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070emp default: description: Error response schema: #/definitions/genericError /retencoes/entities/e070fil: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/e070fil default: description: Error response schema: #/definitions/genericError /retencoes/entities/e070fil/{id}: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070fil default: description: Error response schema: #/definitions/genericError /retencoes/entities/e001pes: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/e001pes default: description: Error response schema: #/definitions/genericError /retencoes/entities/e001pes/{id}: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e001pes default: description: Error response schema: #/definitions/genericError /retencoes/entities/saldoCsrf: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/saldoCsrf responses: 200: description: The created resource schema: #/definitions/saldoCsrf default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/saldoCsrf responses: 200: description: The created resource schema: #/definitions/saldoCsrf default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/saldoCsrf default: description: Error response schema: #/definitions/genericError /retencoes/entities/saldoCsrf/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/saldoCsrf responses: 200: description: Ok schema: #/definitions/saldoCsrf default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/saldoCsrf responses: 200: description: Ok schema: #/definitions/saldoCsrf default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/saldoCsrf default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /retencoes/entities/saldoCsrf/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/saldoCsrf responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /retencoes/entities/saldoIrrf: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/saldoIrrf responses: 200: description: The created resource schema: #/definitions/saldoIrrf default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/saldoIrrf responses: 200: description: The created resource schema: #/definitions/saldoIrrf default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/saldoIrrf default: description: Error response schema: #/definitions/genericError /retencoes/entities/saldoIrrf/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/saldoIrrf responses: 200: description: Ok schema: #/definitions/saldoIrrf default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/saldoIrrf responses: 200: description: Ok schema: #/definitions/saldoIrrf default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/saldoIrrf default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /retencoes/entities/saldoIrrf/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/saldoIrrf responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /retencoes/entities/saldoIss: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/saldoIss responses: 200: description: The created resource schema: #/definitions/saldoIss default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/saldoIss responses: 200: description: The created resource schema: #/definitions/saldoIss default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/saldoIss default: description: Error response schema: #/definitions/genericError /retencoes/entities/saldoIss/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/saldoIss responses: 200: description: Ok schema: #/definitions/saldoIss default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/saldoIss responses: 200: description: Ok schema: #/definitions/saldoIss default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/saldoIss default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /retencoes/entities/saldoIss/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/saldoIss responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /retencoes/entities/saldoInss: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/saldoInss responses: 200: description: The created resource schema: #/definitions/saldoInss default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/saldoInss responses: 200: description: The created resource schema: #/definitions/saldoInss default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/saldoInss default: description: Error response schema: #/definitions/genericError /retencoes/entities/saldoInss/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/saldoInss responses: 200: description: Ok schema: #/definitions/saldoInss default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/saldoInss responses: 200: description: Ok schema: #/definitions/saldoInss default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/saldoInss default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /retencoes/entities/saldoInss/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/saldoInss responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /retencoes/entities/saldoInssPatronal: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/saldoInssPatronal responses: 200: description: The created resource schema: #/definitions/saldoInssPatronal default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/saldoInssPatronal responses: 200: description: The created resource schema: #/definitions/saldoInssPatronal default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/saldoInssPatronal default: description: Error response schema: #/definitions/genericError /retencoes/entities/saldoInssPatronal/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/saldoInssPatronal responses: 200: description: Ok schema: #/definitions/saldoInssPatronal default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/saldoInssPatronal responses: 200: description: Ok schema: #/definitions/saldoInssPatronal default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/saldoInssPatronal default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /retencoes/entities/saldoInssPatronal/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/saldoInssPatronal responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /retencoes/entities/saldoProgressivoIrrf: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/saldoProgressivoIrrf responses: 200: description: The created resource schema: #/definitions/saldoProgressivoIrrf default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/saldoProgressivoIrrf responses: 200: description: The created resource schema: #/definitions/saldoProgressivoIrrf default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/saldoProgressivoIrrf default: description: Error response schema: #/definitions/genericError /retencoes/entities/saldoProgressivoIrrf/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/saldoProgressivoIrrf responses: 200: description: Ok schema: #/definitions/saldoProgressivoIrrf default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/saldoProgressivoIrrf responses: 200: description: Ok schema: #/definitions/saldoProgressivoIrrf default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/saldoProgressivoIrrf default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /retencoes/entities/saldoProgressivoIrrf/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/saldoProgressivoIrrf responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: upDown: description: Up or down type: string enum: – UP – DOWN tipoOperacao: description: Contém o tipo de operação do impostos type: string enum: – ENTRADA – SAIDA – AMBOS enumOrigemDocumento: description: Origem do documento type: string enum: – NF_SAIDA – NF_ENTRADA – FINANCEIRO_CP – MANUAL enumImpostos: description: Impostos type: string enum: – ISS_RETIDO – PIS_RETIDO – COFINS_RETIDO – CSLL – IRRF – INSS – INSS_PATRONAL enumJurFis: description: Tipo de pessoa type: string enum: – VJ – VF enumSitReg: description: Situação do registro type: string enum: – VA – VI enumOrigemRetencao: description: Origem de retenção no saldo type: string enum: – EMPRESA – TERCEIRO userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – 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 informacaoDocumento: description: Informações do documento type: object required: – empresaCodigo – emitente – tipoOperacao – destinatario – documento – itens properties: empresaCodigo: type: integer format: int64 description: Código da empresa – Código de negócio minimum: 0 emitente: type: object allOf: – #/definitions/participante description: Dados para identificação do emitente cidadeOrigem: type: integer format: int64 description: Cidade de origem – código do IBGE para identificar origem do imposto minimum: 0 maximum: 9999999 cidadeDestino: type: integer format: int64 description: Cidade de destino – código do IBGE para identificar o destino do imposto minimum: 0 maximum: 9999999 tipoOperacao: type: string allOf: – #/definitions/tipoOperacao description: Tipo de operação: Entrada ou Saída operacao: type: string description: Código da operação destinatario: type: object allOf: – #/definitions/participante description: Dados para identificação do destinatário documento: type: object allOf: – #/definitions/documento description: Dados do documento itens: type: array items: type: object allOf: – #/definitions/item minimum: 1 description: Dados dos itens do documento a ser calculado retornoCalculo: description: Retorno do calculo type: object properties: idDocumento: type: string description: Id do documento itens: type: array items: type: object allOf: – #/definitions/retornoItem description: Itens do documento retornoItem: description: Retorno do item type: object properties: idItem: type: string description: Id do item no documento impostos: type: array items: type: object allOf: – #/definitions/retornoImpostos description: Impostos do item retornoImpostos: description: Retorno dos impostos type: object properties: tipoImposto: type: string allOf: – #/definitions/enumImpostos description: Tipo do imposto base: type: string description: Base valor: type: string description: Valor aliquota: type: number format: double description: Aliquota participante: description: Representa algum participante da operação, podendo ser emitente ou destinatário type: object properties: cnpjCpf: type: string description: CNPJ/CPF do participante. Somente os números, sem formatação nif: type: string description: Código NIF (Número de Identificação Fiscal) codigo: type: integer format: int64 description: Código do participante minimum: 0 maximum: 999999999 documento: description: Representa informações sobre o documento que está solicitando calculo type: object required: – id – origem – descricaoDocumento – dataEmissao properties: id: type: string description: Código de identificação do documento origem: type: string allOf: – #/definitions/enumOrigemDocumento description: Origem do documento descricaoDocumento: type: string description: Descrição do documento dataEmissao: type: string format: date-time description: Data de emissão do documento dataEntrada: type: string format: date-time description: Data de entrada do documento dataCambio: type: string format: date-time description: Data de cambio da moeda 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 item: description: Representa informações sobre o item que está sendo calculado type: object required: – id properties: id: type: string description: Código de identificação do item produto: type: object allOf: – #/definitions/produto description: Dados do produto servico: type: object allOf: – #/definitions/servico description: Dados do serviço irrf: type: object allOf: – #/definitions/imposto description: IRRF csll: type: object allOf: – #/definitions/imposto description: CSLL pisRetido: type: object allOf: – #/definitions/imposto description: PIS Retido cofinsRetido: type: object allOf: – #/definitions/imposto description: COFINS Retido issRetido: type: object allOf: – #/definitions/imposto description: ISS Retido inss: type: object allOf: – #/definitions/imposto description: INSS inssPatronal: type: object allOf: – #/definitions/imposto description: INSS Patronal produto: description: Contém informações que definem ou identificam um produto type: object properties: exIpi: type: string description: Exceção do IPI ncm: type: string description: NCM – Nomenclatura Comum do Mercosul codigoProduto: type: string description: Código do produto gtinEan: type: string description: Código EAN servico: description: Contém informações que definem ou identificam um serviço type: object properties: nbs: type: string description: Código da NBS – Nomenclatura Brasileira de Serviços codigoServico: type: string description: Código do serviço lc1162003: type: string description: Código da Lei complementar 116/2003 imposto: description: Contem informações do imposto type: object properties: base: type: string description: Valor da base de calculo aliquota: type: number format: double description: Aliquota do imposto valor: type: string description: Valor do imposto recFatoContabil: description: Informações do fato contábil type: object properties: fatoContabilId: type: string description: Identificador descricaoFatoContabil: type: string description: Descrição 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 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: 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 cnpCpf: type: string maxLength: 14 description: CNPJ/CPF numIdf: type: string maxLength: 40 description: Número de identificação fiscal (NIF) sitPes: type: string allOf: – #/definitions/enumSitReg description: Situação qtdDep: type: integer format: int64 description: Quantidade de dependentes minimum: 0 maximum: 9999 vlrPen: type: string description: Valor da Pensão judicial/alimentícia minimum: 0.00 maximum: 99999999.99 extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração 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: saldoCsrf: description: Controle de saldo de contribuições sociais PIS/COFINS/CSLL type: object required: – e070emp – e070fil – tipoOperacao – imposto – e001pes – data – documento – origem – base – valor properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070fil: type: object allOf: – #/definitions/e070fil description: Filial tipoOperacao: type: string allOf: – #/definitions/tipoOperacao description: Tipo de Operação imposto: type: string allOf: – #/definitions/enumImpostos description: Imposto codigoArrecadacao: type: string maxLength: 10 description: Código de arrecadação e001pes: type: object allOf: – #/definitions/e001pes description: Participante data: type: string format: date-time description: Data da operação documento: type: string maxLength: 250 description: Identificação do documento origem: type: string allOf: – #/definitions/enumOrigemRetencao description: Origem da retenção base: type: string description: Base do imposto retido valor: type: string description: Valor do imposto documentoDescricao: type: string maxLength: 510 description: Documento descrição usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: saldoIrrf: description: Controle de saldo de Irrf type: object required: – e070emp – e070fil – tipoOperacao – imposto – e001pes – data – documento – origem – base – valor properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070fil: type: object allOf: – #/definitions/e070fil description: Filial tipoOperacao: type: string allOf: – #/definitions/tipoOperacao description: Tipo de Operação imposto: type: string allOf: – #/definitions/enumImpostos description: Imposto codigoArrecadacao: type: string maxLength: 10 description: Código de arrecadação e001pes: type: object allOf: – #/definitions/e001pes description: Participante data: type: string format: date-time description: Data da operação documento: type: string maxLength: 250 description: Identificação do documento origem: type: string allOf: – #/definitions/enumOrigemRetencao description: Origem da retenção base: type: string description: Base do imposto retido valor: type: string description: Valor do imposto documentoDescricao: type: string maxLength: 510 description: Documento descrição usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: saldoIss: description: Controle de saldo de ISS type: object required: – e070emp – e070fil – tipoOperacao – imposto – e001pes – data – documento – origem – base – valor properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070fil: type: object allOf: – #/definitions/e070fil description: Filial tipoOperacao: type: string allOf: – #/definitions/tipoOperacao description: Tipo de Operação imposto: type: string allOf: – #/definitions/enumImpostos description: Imposto codigoArrecadacao: type: string maxLength: 10 description: Código de arrecadação e001pes: type: object allOf: – #/definitions/e001pes description: Participante data: type: string format: date-time description: Data da operação documento: type: string maxLength: 250 description: Identificação do documento origem: type: string allOf: – #/definitions/enumOrigemRetencao description: Origem da retenção base: type: string description: Base do imposto retido valor: type: string description: Valor do imposto usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: saldoInss: description: Controle de saldo de INSS e INSS PROGRESSIVO type: object required: – e070emp – e070fil – tipoOperacao – imposto – e001pes – data – documento – origem – base – valor properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070fil: type: object allOf: – #/definitions/e070fil description: Filial tipoOperacao: type: string allOf: – #/definitions/tipoOperacao description: Tipo de Operação imposto: type: string allOf: – #/definitions/enumImpostos description: Imposto codigoArrecadacao: type: string maxLength: 10 description: Código de arrecadação e001pes: type: object allOf: – #/definitions/e001pes description: Participante data: type: string format: date-time description: Data da operação documento: type: string maxLength: 250 description: Identificação do documento origem: type: string allOf: – #/definitions/enumOrigemRetencao description: Origem da retenção base: type: string description: Base do imposto retido valor: type: string description: Valor do imposto documentoDescricao: type: string maxLength: 510 description: Documento descrição valorTributado: type: string description: Valor do INSS tributado tributado: type: boolean description: Indicativo se o INSS ja foi tributado usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: saldoInssPatronal: description: Controle de saldo de INSS Patronal type: object required: – e070emp – e070fil – tipoOperacao – imposto – e001pes – data – documento – origem – base – valor properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070fil: type: object allOf: – #/definitions/e070fil description: Filial tipoOperacao: type: string allOf: – #/definitions/tipoOperacao description: Tipo de Operação imposto: type: string allOf: – #/definitions/enumImpostos description: Imposto codigoArrecadacao: type: string maxLength: 10 description: Código de arrecadação e001pes: type: object allOf: – #/definitions/e001pes description: Participante data: type: string format: date-time description: Data da operação documento: type: string maxLength: 250 description: Identificação do documento origem: type: string allOf: – #/definitions/enumOrigemRetencao description: Origem da retenção base: type: string description: Base do imposto retido valor: type: string description: Valor do imposto documentoDescricao: type: string maxLength: 510 description: Documento descrição valorTributado: type: string description: Valor do INSS tributado tributado: type: boolean description: Indicativo se o INSS ja foi tributado usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: saldoProgressivoIrrf: description: Controle de saldo da tabela progressiva de IRRF type: object required: – e070emp – e070fil – tipoOperacao – imposto – e001pes – data – documento – origem – base – valor properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070fil: type: object allOf: – #/definitions/e070fil description: Filial tipoOperacao: type: string allOf: – #/definitions/tipoOperacao description: Tipo de Operação imposto: type: string allOf: – #/definitions/enumImpostos description: Imposto codigoArrecadacao: type: string maxLength: 10 description: Código de arrecadação e001pes: type: object allOf: – #/definitions/e001pes description: Participante data: type: string format: date-time description: Data da operação documento: type: string maxLength: 250 description: Identificação do documento origem: type: string allOf: – #/definitions/enumOrigemRetencao description: Origem da retenção base: type: string description: Base do imposto retido valor: type: string description: Valor do imposto documentoDescricao: type: string maxLength: 510 description: Documento descrição valorTributado: type: string description: Valor do IRRF tributado inssDescontado: type: string description: Valor do INSS descontado no IRRF tributado tributado: type: boolean description: Indicativo se o INSS ja foi tributado 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