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

guias_impostos

16 views 0 27/02/2020 Atualizado em 04/08/2020 integrador

2.0info: 1.4.0 guias_impostos description: Impostos – Guias x-senior-domain: erpx_cpl x-senior-domain-path: erpx_cpl x-senior-service-path: guias_impostos 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: /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 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 /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 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: 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 /guias_impostos/queries/exportE008cep: 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 /guias_impostos/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 /guias_impostos/queries/exportE006pai: 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 /guias_impostos/queries/exportE008rai: 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 /guias_impostos/queries/exportE007ufs: 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 /guias_impostos/queries/exportE002tpt: 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 /guias_impostos/queries/exportParametros: 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 /guias_impostos/queries/exportParametrosFinanceiros: 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 /guias_impostos/queries/exportGuias: 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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/queries/exportE001tns: 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 /guias_impostos/queries/exportE025fer: 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 /guias_impostos/queries/exportGuiasComErro: 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 /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: 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 /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 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 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 guia gerada default: description: Error response schema: #/definitions/genericError /guias_impostos/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response default: description: Error response schema: #/definitions/genericError /guias_impostos/actions/importE008cep: 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 /guias_impostos/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 /guias_impostos/actions/importE006pai: 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 /guias_impostos/actions/importE008rai: 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 /guias_impostos/actions/importE007ufs: 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 /guias_impostos/actions/importE002tpt: 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 /guias_impostos/actions/importParametros: 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 /guias_impostos/actions/importParametrosFinanceiros: 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 /guias_impostos/actions/importGuias: 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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/actions/importE001tns: 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 /guias_impostos/actions/importE025fer: 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 /guias_impostos/actions/importGuiasComErro: 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 /guias_impostos/entities/e008cep: 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/e008cep default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/e008cep/{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/e008cep default: description: Error response schema: #/definitions/genericError /guias_impostos/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 /guias_impostos/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 /guias_impostos/entities/e006pai: 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/e006pai default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/e006pai/{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/e006pai default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/e008rai: 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/e008rai default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/e008rai/{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/e008rai default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/e007ufs: 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/e007ufs default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/e007ufs/{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/e007ufs default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/e002tpt: 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/e002tpt default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/e002tpt/{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/e002tpt default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/parametros: post: description: This entity is customizable. 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 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/parametros responses: 200: description: The created resource schema: #/definitions/parametros 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/parametros default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/parametros/{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/parametros responses: 200: description: Ok schema: #/definitions/parametros 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/parametros responses: 200: description: Ok schema: #/definitions/parametros 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/parametros 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 /guias_impostos/entities/parametros/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/parametros responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/parametrosFinanceiros: post: description: This entity is customizable. 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 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/parametrosFinanceiros responses: 200: description: The created resource schema: #/definitions/parametrosFinanceiros 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/parametrosFinanceiros default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/parametrosFinanceiros/{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/parametrosFinanceiros responses: 200: description: Ok schema: #/definitions/parametrosFinanceiros 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/parametrosFinanceiros responses: 200: description: Ok schema: #/definitions/parametrosFinanceiros 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/parametrosFinanceiros 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 /guias_impostos/entities/parametrosFinanceiros/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/parametrosFinanceiros responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/guias: post: description: This entity is customizable. 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 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/guias responses: 200: description: The created resource schema: #/definitions/guias 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/guias default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/guias/{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/guias responses: 200: description: Ok schema: #/definitions/guias 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/guias responses: 200: description: Ok schema: #/definitions/guias 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/guias 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 /guias_impostos/entities/guias/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/guias responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/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 /guias_impostos/entities/e001tns: 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/e001tns default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/e001tns/{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/e001tns default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/e025fer: 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/e025fer default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/e025fer/{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/e025fer default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/guiasComErro: post: description: This entity is customizable. 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 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/guiasComErro responses: 200: description: The created resource schema: #/definitions/guiasComErro 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/guiasComErro default: description: Error response schema: #/definitions/genericError /guias_impostos/entities/guiasComErro/{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/guiasComErro responses: 200: description: Ok schema: #/definitions/guiasComErro 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/guiasComErro responses: 200: description: Ok schema: #/definitions/guiasComErro 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/guiasComErro 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 /guias_impostos/entities/guiasComErro/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/guiasComErro 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 enumRegimeControleRetencao: description: Regime controle retenção type: string enum: – COMPETENCIA – CAIXA 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: – AGUARDANDO_PAGAMENTO – CANCELADA – PAGA 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 – DATA_PAGAMENTO 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 enumIntegracaoFinanceira: description: Situação da integração com o finanças type: string enum: – NAO_INTEGRADO – TITULO_GERADO – TITULO_GERADO_CONTABILIZADO – TITULO_PAGO 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 informacaoOrigemGuia: description: Informações da origem da guia 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/guiaRecolhimento minimum: 1 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 dataCambio: type: string format: date description: Data da contratação do câmbio 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: Orgão de recolhimento regimeControleRetencao: type: string allOf: – #/definitions/enumRegimeControleRetencao description: Regime controle retencao 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 recFatoContabil: description: Informações do fato contábil type: object properties: fatoContabilId: type: string description: Identificador descricaoFatoContabil: type: string description: Descrição e008cep: description: CEP type: object required: – cepIni properties: id: type: string format: uuid description: Id da entidade cepIni: type: integer format: int64 description: CEP endereço minimum: 0 maximum: 99999999 baiEnd: type: string maxLength: 75 description: Bairro logEnd: type: string maxLength: 255 description: Logradouro e008rai: type: object allOf: – #/definitions/e008rai description: Cidade 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: 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) e008cep: type: object allOf: – #/definitions/e008cep description: CEP endPes: type: string maxLength: 100 description: Endereço numEnd: type: string maxLength: 60 description: Número cplEnd: type: string maxLength: 200 description: Complemento nomBai: type: string maxLength: 75 description: Bairro e006pai: type: object allOf: – #/definitions/e006pai description: Pais e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado e008rai: type: object allOf: – #/definitions/e008rai description: Cidade 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 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 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 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 transacaoFinanceira: type: object allOf: – #/definitions/e001tns description: Transação financeira tipoTitulo: type: object allOf: – #/definitions/e002tpt description: Tipo de título 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 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 description: Mensagem de erro reprocessable: type: boolean description: Indicativo se é possível reprocessar a Guia 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