2.0info: 1.18.0 (PRIVATE) – COMERCIAL description: ERPX x-senior-domain: ERPX_FND x-senior-domain-path: erpx_fnd x-senior-service-path: comercial contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /private/erpx_fnd/comercialsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: #/definitions/upDown checks: #/definitions/checkData default: description: Error response schema: #/definitions/genericError /verificaTotalParcelas: post: description: Verifica se a quantidade de parcelas está correta x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador da condição de pagamento quantidadeParcela: type: integer description: Quantidade a simular (opcional) responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: #/definitions/retornoVerificacao default: description: Error response schema: #/definitions/genericError /getMetadata: post: description: Default 'getMetadata' query. Every service must handle this command and return metadata in the format requested. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 /verificaPercentualRateio: post: description: Verifica se o percentual de rateio das parcelas está correta x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador da condição de pagamento percentualRateio: type: number description: Percentual a simular (opcional) responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: #/definitions/retornoVerificacao default: description: Error response schema: #/definitions/genericError /calcularPrazoMedio: post: description: Retorna o calculo de prazo médio da condição de pagamento x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador da condição de pagamento responses: 200: description: Ok schema: type: object required: – prazoMedio properties: prazoMedio: type: integer description: Valor do prazo médio default: description: Error response schema: #/definitions/genericError /odata: post: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e066fpgCreated: post: description: Event of e066fpg create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e066fpg responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e066fpgDeleted: post: description: Event of e066fpg delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e066fpg responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e066fpgMerged: post: description: Event of e066fpg merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e066fpg responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e066fpgUpdated: post: description: Event of e066fpg update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e066fpg responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e028cpgCreated: post: description: Event of e028cpg create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e028cpg responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e028cpgDeleted: post: description: Event of e028cpg delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e028cpg responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e028cpgMerged: post: description: Event of e028cpg merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e028cpg responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e028cpgUpdated: post: description: Event of e028cpg update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e028cpg responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e028icpCreated: post: description: Event of e028icp create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e028icp responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e028icpDeleted: post: description: Event of e028icp delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e028icp responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e028icpMerged: post: description: Event of e028icp merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e028icp responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e028icpUpdated: post: description: Event of e028icp update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e028icp responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e085mclCreated: post: description: Event of e085mcl create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e085mcl responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e085mclDeleted: post: description: Event of e085mcl delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e085mcl responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e085mclMerged: post: description: Event of e085mcl merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e085mcl responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e085mclUpdated: post: description: Event of e085mcl update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e085mcl responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e012fxfCreated: post: description: Event of e012fxf create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e012fxf responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e012fxfDeleted: post: description: Event of e012fxf delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e012fxf responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e012fxfMerged: post: description: Event of e012fxf merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e012fxf responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e012fxfUpdated: post: description: Event of e012fxf update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e012fxf responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e014cclCreated: post: description: Event of e014ccl create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e014ccl responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e014cclDeleted: post: description: Event of e014ccl delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e014ccl responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e014cclMerged: post: description: Event of e014ccl merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e014ccl responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e014cclUpdated: post: description: Event of e014ccl update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e014ccl responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e014cccCreated: post: description: Event of e014ccc create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e014ccc responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e014cccDeleted: post: description: Event of e014ccc delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e014ccc responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e014cccMerged: post: description: Event of e014ccc merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e014ccc responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e014cccUpdated: post: description: Event of e014ccc update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e014ccc responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e073veiownerCreated: post: description: Event of e073veiOwner create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e073veiOwner responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e073veiownerDeleted: post: description: Event of e073veiOwner delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e073veiOwner responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e073veiownerMerged: post: description: Event of e073veiOwner merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e073veiOwner responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e073veiownerUpdated: post: description: Event of e073veiOwner update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e073veiOwner responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e073veiCreated: post: description: Event of e073vei create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e073vei responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e073veiDeleted: post: description: Event of e073vei delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e073vei responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e073veiMerged: post: description: Event of e073vei merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e073vei responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e073veiUpdated: post: description: Event of e073vei update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e073vei responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /serviceStarted: post: description: Default 'serviceStarted' event. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – domain – service properties: domain: type: string description: service: type: string description: responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /notifyUserEvent: post: description: Default 'notifyUser' event. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/notifyUserEventPayload responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e001pes: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e001pes default: description: Error response schema: #/definitions/genericError /entities/e073pes: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e073pes default: description: Error response schema: #/definitions/genericError /entities/e076mar: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e076mar default: description: Error response schema: #/definitions/genericError /entities/e073vei: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e073vei responses: 200: description: The created resource schema: #/definitions/e073vei default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e073vei responses: 200: description: The created resource schema: #/definitions/e073vei default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e073vei default: description: Error response schema: #/definitions/genericError /entities/e073vei/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e073vei responses: 200: description: Ok schema: #/definitions/e073vei default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e073vei responses: 200: description: Ok schema: #/definitions/e073vei default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e073vei default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e073vei/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e073vei responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e028cpg_E028icp: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e028cpg_E028icp responses: 200: description: The created resource schema: #/definitions/e028cpg_E028icp default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e028cpg_E028icp responses: 200: description: The created resource schema: #/definitions/e028cpg_E028icp default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e028cpg_E028icp default: description: Error response schema: #/definitions/genericError /entities/e028cpg_E028icp/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e028cpg_E028icp responses: 200: description: Ok schema: #/definitions/e028cpg_E028icp default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e028cpg_E028icp responses: 200: description: Ok schema: #/definitions/e028cpg_E028icp default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e028cpg_E028icp default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e007ufs: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e007ufs default: description: Error response schema: #/definitions/genericError /entities/e012fam: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e012fam default: description: Error response schema: #/definitions/genericError /entities/e012fxf: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e012fxf responses: 200: description: The created resource schema: #/definitions/e012fxf default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e012fxf responses: 200: description: The created resource schema: #/definitions/e012fxf default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e012fxf default: description: Error response schema: #/definitions/genericError /entities/e012fxf/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e012fxf responses: 200: description: Ok schema: #/definitions/e012fxf default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e012fxf responses: 200: description: Ok schema: #/definitions/e012fxf default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e012fxf default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e012fxf/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e012fxf responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e073veiOwner: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e073veiOwner responses: 200: description: The created resource schema: #/definitions/e073veiOwner default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e073veiOwner responses: 200: description: The created resource schema: #/definitions/e073veiOwner default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e073veiOwner default: description: Error response schema: #/definitions/genericError /entities/e073veiOwner/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e073veiOwner responses: 200: description: Ok schema: #/definitions/e073veiOwner default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e073veiOwner responses: 200: description: Ok schema: #/definitions/e073veiOwner default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e073veiOwner default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e073veiOwner/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e073veiOwner responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e085mcl: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e085mcl responses: 200: description: The created resource schema: #/definitions/e085mcl default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e085mcl responses: 200: description: The created resource schema: #/definitions/e085mcl default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e085mcl default: description: Error response schema: #/definitions/genericError /entities/e085mcl/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e085mcl responses: 200: description: Ok schema: #/definitions/e085mcl default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e085mcl responses: 200: description: Ok schema: #/definitions/e085mcl default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e085mcl default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e085mcl/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e085mcl responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e020snf: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e020snf default: description: Error response schema: #/definitions/genericError /entities/e070emp: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e070emp default: description: Error response schema: #/definitions/genericError /entities/e070fil: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e070fil default: description: Error response schema: #/definitions/genericError /entities/e006pai: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e006pai default: description: Error response schema: #/definitions/genericError /entities/e014ccc: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e014ccc responses: 200: description: The created resource schema: #/definitions/e014ccc default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e014ccc responses: 200: description: The created resource schema: #/definitions/e014ccc default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e014ccc default: description: Error response schema: #/definitions/genericError /entities/e014ccc/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e014ccc responses: 200: description: Ok schema: #/definitions/e014ccc default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e014ccc responses: 200: description: Ok schema: #/definitions/e014ccc default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e014ccc default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e014ccc/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e014ccc responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e028icp: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e028icp responses: 200: description: The created resource schema: #/definitions/e028icp default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e028icp responses: 200: description: The created resource schema: #/definitions/e028icp default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e028icp default: description: Error response schema: #/definitions/genericError /entities/e028icp/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e028icp responses: 200: description: Ok schema: #/definitions/e028icp default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e028icp responses: 200: description: Ok schema: #/definitions/e028icp default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e028icp default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e028icp/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e028icp responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e066fpg: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e066fpg responses: 200: description: The created resource schema: #/definitions/e066fpg default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e066fpg responses: 200: description: The created resource schema: #/definitions/e066fpg default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e066fpg default: description: Error response schema: #/definitions/genericError /entities/e066fpg/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e066fpg responses: 200: description: Ok schema: #/definitions/e066fpg default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e066fpg responses: 200: description: Ok schema: #/definitions/e066fpg default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e066fpg default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e066fpg/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e066fpg responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e028cpg: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e028cpg responses: 200: description: The created resource schema: #/definitions/e028cpg default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e028cpg responses: 200: description: The created resource schema: #/definitions/e028cpg default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e028cpg default: description: Error response schema: #/definitions/genericError /entities/e028cpg/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e028cpg responses: 200: description: Ok schema: #/definitions/e028cpg default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e028cpg responses: 200: description: Ok schema: #/definitions/e028cpg default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e028cpg default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e028cpg/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e028cpg responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e014ccl: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e014ccl responses: 200: description: The created resource schema: #/definitions/e014ccl default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e014ccl responses: 200: description: The created resource schema: #/definitions/e014ccl default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e014ccl default: description: Error response schema: #/definitions/genericError /entities/e014ccl/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e014ccl responses: 200: description: Ok schema: #/definitions/e014ccl default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e014ccl responses: 200: description: Ok schema: #/definitions/e014ccl default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e014ccl default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e014ccl/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e014ccl responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e001pes_E073pes: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e001pes_E073pes responses: 200: description: The created resource schema: #/definitions/e001pes_E073pes default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e001pes_E073pes responses: 200: description: The created resource schema: #/definitions/e001pes_E073pes default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e001pes_E073pes default: description: Error response schema: #/definitions/genericError /entities/e001pes_E073pes/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e001pes_E073pes responses: 200: description: Ok schema: #/definitions/e001pes_E073pes default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e001pes_E073pes responses: 200: description: Ok schema: #/definitions/e001pes_E073pes default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e001pes_E073pes default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e075der: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e075der default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN enumTipFpg: type: string enum: – V01 – V02 – V03 – V04 – V05 – V10 – V11 – V12 – V13 – V15 – V16 – V17 – V18 – V19 – V90 – V99 enumSitReg: type: string enum: – VA – VI enumAplCpg: type: string enum: – VV – VC – VA enumTipPar: type: string enum: – V1 – V2 – V3 enumDiaEspCurto: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 enumIndPag: type: string enum: – V0 – V1 enumTipCju: type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 enumJurFis: type: string enum: – VJ – VF enumTipEmp: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V99 enumAplSnf: type: string enum: – VS – VM – VE – VF – VD enumTipPrt: type: string enum: – V0 – V1 – V2 enumTpoTra: type: string enum: – V1 – V2 – V3 enumProVei: type: string enum: – PROPRIO – TERCEIRO enumTipRod: type: string enum: – V01 – V02 – V03 – V04 – V05 – V06 enumTipCrr: type: string enum: – V00 – V01 – V02 – V03 – V04 – V05 enumTipVei: type: string enum: – VEICULO – REBOQUE userNotificationKind: type: string enum: – Operational – Management – News userNotificationPriority: type: string enum: – Error – Alert – None checkData: type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: #/definitions/upDown retornoVerificacao: type: object required: – invalidoMenor – invalidoMaior properties: invalidoMenor: type: boolean description: Inválido para menor invalidoMaior: type: boolean description: Inválido para maior e066fpg: type: object required: – e070emp – codFpg – desFpg – abrFpg – tipFpg – sitFpg properties: id: type: string description: format: uuid e070emp: #/definitions/e070emp codFpg: type: integer description: Código forma pagamento desFpg: type: string description: Descrição abrFpg: type: string description: Abreviatura tipFpg: #/definitions/enumTipFpg sitFpg: #/definitions/enumSitReg excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e070emp: type: object required: – codEmp – nomEmp – sigEmp properties: id: type: string description: format: uuid codEmp: type: integer description: Código da empresa nomEmp: type: string description: Nome da empresa sigEmp: type: string description: Nome fantasia da empresa excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e028cpg: type: object required: – e070emp – codCpg – desCpg – abrCpg – aplCpg – qtdPar – tipPar – diaEsp – frePar – segPar – embPar – outPar – ipiPar – icmPar – subPar – encPar – irfPar – sitCpg properties: id: type: string description: format: uuid e070emp: #/definitions/e070emp codCpg: type: string description: Código da condição de pagamento desCpg: type: string description: Descrição da condição de pagamento abrCpg: type: string description: Abreviatura da condição de pagamento aplCpg: #/definitions/enumAplCpg qtdPar: type: integer description: Quantidade total de parcelas da condição de pagamento tipPar: #/definitions/enumTipPar diaEsp: #/definitions/enumDiaEspCurto przMed: type: integer description: Prazo médio da condição de pagamento diaMe1: type: integer description: Primeiro dia especial do mês para vencimento das parcelas diaMe2: type: integer description: Segundo dia especial do mês para vencimento das parcelas diaMe3: type: integer description: Terceiro dia especial do mês para vencimento das parcelas frePar: type: boolean description: Indicativo se o valor total do frete deve estar na 1ª parcela segPar: type: boolean description: Indicativo se o valor total do seguro deve estar na 1ª parcela embPar: type: boolean description: Indicativo se o valor total das embalagens deve estar na 1ª parcela outPar: type: boolean description: Indicativo se o valor total das outras despesas deve estar na 1ª parcela ipiPar: type: boolean description: Indicativo se o valor total do IPI deve estar na 1ª parcela icmPar: type: boolean description: Indicativo se o valor total do ICMS deve estar na 1ª parcela subPar: type: boolean description: Indicativo se o valor total do ICMS substituído deve estar na 1ª parcela encPar: type: boolean description: Indicativo se o valor total dos encargos deve estar na 1ª parcela issPar: type: boolean description: Indicativo se o valor total do ISS deve estar na 1ª parcela irfPar: type: boolean description: Indicativo se o valor total do irrf deve estar na 1ª parcela sitCpg: #/definitions/enumSitReg e028icp: type: array items: #/definitions/e028icp description: Parcelas cprDsc: type: number description: Preço Compra format: double diaFix: type: boolean description: O dia do vencimento é fixo para períodos de 30 em 30 dias venDsc: type: number description: Percentual para formação do preço de venda format: double perCom: type: number description: Percentual para formação da comissão do representante format: double redCom: type: number description: Percentual redutor do valor base comissão format: double tipCju: #/definitions/enumTipCju txaJur: type: number description: Percentual de juros format: double dscAnt: type: number description: Percentual de desconto por antecipação format: double dscPon: type: number description: Percentual de desconto por pontualidade format: double jurVen: type: boolean description: Calcular juros desde a data de venda inssPrimeiraParcela: type: boolean description: Deduzir INSS da 1ª parcela csrfPrimeiraParcela: type: boolean description: Deduzir CSRF da 1ª parcela excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e028icp: type: object required: – seqIcp – qtdPar properties: id: type: string description: format: uuid e028cpg: #/definitions/e028cpg seqIcp: type: integer description: Ordem sequencial para controle das parcelas qtdPar: type: integer description: Quantidade de parcelas diaPar: type: integer description: Quantidade de dias de intervalo entre as parcelas perRat: type: number description: Percentual do total a ser considera para a condição de pagamento format: double indPag: #/definitions/enumIndPag e066fpg: #/definitions/e066fpg excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e085mcl: type: object required: – e001pesCodCli – e070emp – e076mar – e001pesCodRep properties: id: type: string description: format: uuid e001pesCodCli: #/definitions/e001pes e070emp: #/definitions/e070emp e076mar: #/definitions/e076mar e001pesCodRep: #/definitions/e001pes e028cpg: #/definitions/e028cpg e066fpg: #/definitions/e066fpg e001pesCodTra: #/definitions/e001pes e001pesCodRed: #/definitions/e001pes excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e001pes: type: object required: – codPes – nomPes – sitPes – cnpCpf – tipPes properties: id: type: string description: format: uuid codPes: type: integer description: Pessoa nomPes: type: string description: Nome apePes: type: string description: Fantasia sitPes: #/definitions/enumSitReg cnpCpf: type: string description: CNPJ/CPF tipPes: #/definitions/enumJurFis numIdf: type: string description: Número identificação fiscal excluido: type: boolean description: Indica se o registro foi excluído e073pes: #/definitions/e073pes usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e073pes: type: object required: – sitTra properties: id: type: string description: format: uuid e001pes: #/definitions/e001pes sitTra: #/definitions/enumSitReg excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e076mar: type: object required: – codMar – nomMar – sitMar properties: id: type: string description: format: uuid codMar: type: string description: Código da marca/etiqueta vinculada a um produto ou a um pedido nomMar: type: string description: Nome da marca sitMar: #/definitions/enumSitReg excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e012fxf: type: object required: – e070emp – e012fam – e001pes properties: id: type: string description: format: uuid e070emp: #/definitions/e070emp e012fam: #/definitions/e012fam e001pes: #/definitions/e001pes excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e012fam: type: object required: – e070emp – codFam – desFam – posPro properties: id: type: string description: format: uuid e070emp: #/definitions/e070emp codFam: type: string description: Código desFam: type: string description: Descrição posPro: type: integer description: Quantidade de posições para o código de produto sitFam: #/definitions/enumSitReg excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e014ccl: type: object required: – codCcl – desCcl properties: id: type: string description: format: uuid codCcl: type: string description: Característica desCcl: type: string description: Descrição abrCcl: type: string description: Abreviatura excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e014ccc: type: object required: – e014ccl – codCcc – desCcc properties: id: type: string description: format: uuid e014ccl: #/definitions/e014ccl codCcc: type: integer description: Componente desCcc: type: string description: Descrição abrCcc: type: string description: Abreviatura excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e075der: type: object required: – e070emp – e012fam – codDer – desDer – codBar – sitDer properties: id: type: string description: format: uuid e070emp: #/definitions/e070emp e012fam: #/definitions/e012fam codDer: type: string description: Derivação desDer: type: string description: Descrição desCpl: type: string description: Descrição complementar codBar: type: string description: Código de barras codBa2: type: string description: Código barras livre codGtn: type: string description: Gtin uni. trib idePro: type: string description: Identificação produto codRef: type: string description: Código da Referência sitDer: #/definitions/enumSitReg excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e020snf: type: object required: – e070emp – e070fil – codSnf – desSnf – abrSnf – aplSnf – qtdPar properties: id: type: string description: format: uuid e070emp: #/definitions/e070emp e070fil: #/definitions/e070fil codSnf: type: string description: Código desSnf: type: string description: Descrição abrSnf: type: string description: Abreviatura aplSnf: #/definitions/enumAplSnf codSel: type: string description: Série codSsl: type: string description: Subsérie qtdPar: type: integer description: Quantidade máxima de parcelas excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e070fil: type: object required: – e070emp – codFil – nomFil – sigFil properties: id: type: string description: format: uuid e070emp: #/definitions/e070emp codFil: type: integer description: Filial nomFil: type: string description: Nome sigFil: type: string description: Fantasia tipEmp: #/definitions/enumTipEmp tipPes: #/definitions/enumJurFis numCgc: type: string description: CPF/CNPJ numIdf: type: string description: Número identificação fiscal intNet: type: string description: E-mail filMat: type: boolean description: Filial matriz excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e006pai: type: object required: – codPai – nomPai – merSul – visEnt properties: id: type: string description: format: uuid codPai: type: string description: Código nomPai: type: string description: Nome merSul: type: boolean description: Mercosul visEnt: type: boolean description: Visto entrada paiDir: type: integer description: Código do país na DIRF paiSis: type: integer description: País Siscomex/Siscoserv excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e007ufs: type: object required: – sigUfs – nomUfs – e006pai properties: id: type: string description: format: uuid sigUfs: type: string description: Sigla nomUfs: type: string description: Nome e006pai: #/definitions/e006pai excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e073veiOwner: type: object required: – tipPes – cnpCpf – nomPes – tipPrt – sitPrt properties: id: type: string description: format: uuid tipPes: #/definitions/enumJurFis cnpCpf: type: string description: CNPJ/CPF do proprietário do veículo nomPes: type: string description: Nome do proprietário do veículo insEst: type: string description: Inscrição estadual do proprietário do veículo e007ufs: #/definitions/e007ufs nrnTrc: type: string description: Número do RNTRC tipPrt: #/definitions/enumTipPrt sitPrt: #/definitions/enumSitReg excluido: type: boolean description: Indica se o registro foi excluído shippingCompanyType: #/definitions/enumTpoTra usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e073vei: type: object required: – e073pes – plaVei – e007ufs – tipVei properties: id: type: string description: format: uuid e073pes: #/definitions/e073pes plaVei: type: string description: Placa do veículo numRen: type: string description: RENAVAM tarVei: type: number description: Tara do veículo format: double pesMax: type: number description: Capacidade máxima em KG format: double volMax: type: number description: Capacidade máxima em M3 format: double proVei: #/definitions/enumProVei tipRod: #/definitions/enumTipRod tipCrr: #/definitions/enumTipCrr e007ufs: #/definitions/e007ufs e073veiOwner: #/definitions/e073veiOwner tipVei: #/definitions/enumTipVei sitVei: #/definitions/enumSitReg excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time notifyUserEventPayload: type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: #/definitions/userNotificationKind notificationPriority: #/definitions/userNotificationPriority 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 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