{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:cnab-online-herokuapp/post-file":{"post":{"operationId":"finance_cnab_online_herokuapp_post_file","summary":"Faz o upload de um arquivo","description":"POST /file","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:cnab-online-herokuapp/get-file-file-id":{"get":{"operationId":"finance_cnab_online_herokuapp_get_file_file_id","summary":"Retorna as informações básicas de um arquivo previamente processado","description":"GET /file/{fileId}","tags":["finance"],"parameters":[{"name":"fileId","in":"query","required":true,"description":"ID Temporário gerado no endpoint file","schema":{"type":"string","description":"ID Temporário gerado no endpoint file"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:cnab-online-herokuapp/get-file-file-id-lines":{"get":{"operationId":"finance_cnab_online_herokuapp_get_file_file_id_lines","summary":"Retorna todas as linhas e seus respectivos campos (de forma não processada, apenas indicando os campos…","description":"GET /file/{fileId}/lines","tags":["finance"],"parameters":[{"name":"fileId","in":"query","required":true,"description":"ID Temporário gerado no endpoint file","schema":{"type":"string","description":"ID Temporário gerado no endpoint file"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:cnab-online-herokuapp/get-file-file-id-occurrences":{"get":{"operationId":"finance_cnab_online_herokuapp_get_file_file_id_occurrences","summary":"Retorna as informações de baixa de boletos e outros tipos de ocorrências","description":"GET /file/{fileId}/occurrences","tags":["finance"],"parameters":[{"name":"fileId","in":"query","required":true,"description":"ID Temporário gerado no endpoint file","schema":{"type":"string","description":"ID Temporário gerado no endpoint file"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}