{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:remote/contract-amendments-list-requests":{"get":{"operationId":"finance_remote_contract_amendments_list_requests","summary":"List Contract Amendment","description":"GET /v1/contract-amendments","tags":["finance"],"parameters":[{"name":"page","in":"query","required":false,"description":"Starts fetching records after the given page","schema":{"type":"integer","default":1,"description":"Starts fetching records after the given page"},"example":1},{"name":"page_size","in":"query","required":false,"description":"Number of items per page","schema":{"type":"integer","default":20,"description":"Number of items per page"},"example":20}],"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":"byok"}},"/v1/finance:remote/contract-amendments-create-request":{"post":{"operationId":"finance_remote_contract_amendments_create_request","summary":"Create Contract Amendment","description":"POST /v1/contract-amendments","tags":["finance"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/time-off-get-record":{"get":{"operationId":"finance_remote_time_off_get_record","summary":"Show Time Off","description":"GET /v1/timeoff/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Timeoff ID","schema":{"type":"string","description":"Timeoff ID"},"example":"93t3j-timeoff-id-9suej43"}],"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":"byok"}},"/v1/finance:remote/time-off-update-record":{"post":{"operationId":"finance_remote_time_off_update_record","summary":"Update Time Off","description":"PUT /v1/timeoff/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Timeoff ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/time-off-update-record-2":{"post":{"operationId":"finance_remote_time_off_update_record_2","summary":"Update Time Off","description":"PATCH /v1/timeoff/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Timeoff ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/incentives-list-all":{"get":{"operationId":"finance_remote_incentives_list_all","summary":"List Incentives","description":"GET /v1/incentives","tags":["finance"],"parameters":[{"name":"employment_id","in":"query","required":false,"description":"Filter by Employment ID","schema":{"type":"string","description":"Filter by Employment ID"},"example":"93t3j-employment-id-9suej43"},{"name":"status","in":"query","required":false,"description":"Filter by Incentive status","schema":{"type":"string","description":"Filter by Incentive status"},"example":"paid"},{"name":"recurring_incentive_id","in":"query","required":false,"description":"Filter by Recurring Incentive id","schema":{"type":"string","description":"Filter by Recurring Incentive id"},"example":"2f900aaf-4952-4ec4-ac7c-2b917a2b4da9"},{"name":"page","in":"query","required":false,"description":"Starts fetching records after the given page","schema":{"type":"integer","description":"Starts fetching records after the given page"},"example":1},{"name":"page_size","in":"query","required":false,"description":"Change the amount of records returned per page, defaults to 20, limited to 100","schema":{"type":"integer","description":"Change the amount of records returned per page, defaults to 20, limited to 100"},"example":30}],"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":"byok"}},"/v1/finance:remote/incentives-create-incentive":{"post":{"operationId":"finance_remote_incentives_create_incentive","summary":"Create Incentive","description":"POST /v1/incentives","tags":["finance"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/custom-fields-list-definitions":{"get":{"operationId":"finance_remote_custom_fields_list_definitions","summary":"Lists custom fields definitions","description":"GET /v1/custom-fields","tags":["finance"],"parameters":[{"name":"page","in":"query","required":false,"description":"Starts fetching records after the given page","schema":{"type":"integer","description":"Starts fetching records after the given page"},"example":1},{"name":"page_size","in":"query","required":false,"description":"Change the amount of records returned per page, defaults to 20, limited to 100","schema":{"type":"integer","description":"Change the amount of records returned per page, defaults to 20, limited to 100"},"example":30}],"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":"byok"}},"/v1/finance:remote/cost-calculator-generate-estimation-pdf":{"post":{"operationId":"finance_remote_cost_calculator_generate_estimation_pdf","summary":"Creates a cost estimation of employments","description":"POST /v1/cost-calculator/estimation-pdf","tags":["finance"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/incentives-show-details":{"get":{"operationId":"finance_remote_incentives_show_details","summary":"Show Incentive","description":"GET /v1/incentives/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Incentive ID","schema":{"type":"string","description":"Incentive ID"}}],"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":"byok"}},"/v1/finance:remote/incentives-update-incentive":{"post":{"operationId":"finance_remote_incentives_update_incentive","summary":"Update Incentive","description":"PUT /v1/incentives/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Incentive ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/incentives-update-incentive-2":{"post":{"operationId":"finance_remote_incentives_update_incentive_2","summary":"Update Incentive","description":"PATCH /v1/incentives/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Incentive ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/incentives-remove-incentive":{"post":{"operationId":"finance_remote_incentives_remove_incentive","summary":"Delete an Incentive","description":"DELETE /v1/incentives/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Incentive ID"}}}}}},"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":"byok"}},"/v1/finance:remote/payslips-list-all":{"get":{"operationId":"finance_remote_payslips_list_all","summary":"List payslips","description":"GET /v1/payslips","tags":["finance"],"parameters":[{"name":"employment_id","in":"query","required":false,"description":"Employment ID","schema":{"type":"string","description":"Employment ID"},"example":"93t3j-employment-id-9suej43"},{"name":"start_date","in":"query","required":false,"description":"Filters by payslips `issued_at` field, after or on the same day than the given date","schema":{"type":"string","description":"Filters by payslips `issued_at` field, after or on the same day than the given date"},"example":"\"2022-12-15\""},{"name":"end_date","in":"query","required":false,"description":"Filters by payslips `issued_at` field, before or or the same day than the given date","schema":{"type":"string","description":"Filters by payslips `issued_at` field, before or or the same day than the given date"},"example":"\"2023-12-15\""},{"name":"expected_payout_start_date","in":"query","required":false,"description":"Filters by payslips `expected_payout_date` field, after or on the same day than the given date","schema":{"type":"string","description":"Filters by payslips `expected_payout_date` field, after or on the same day than the given date"},"example":"\"2022-12-15\""},{"name":"expected_payout_end_date","in":"query","required":false,"description":"Filters by payslips `expected_payout_date` field, before or or the same day than the given date","schema":{"type":"string","description":"Filters by payslips `expected_payout_date` field, before or or the same day than the given date"},"example":"\"2023-12-15\""},{"name":"page","in":"query","required":false,"description":"Starts fetching records after the given page","schema":{"type":"integer","description":"Starts fetching records after the given page"},"example":1},{"name":"page_size","in":"query","required":false,"description":"Change the amount of records returned per page, defaults to 20, limited to 100","schema":{"type":"integer","description":"Change the amount of records returned per page, defaults to 20, limited to 100"},"example":30}],"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":"byok"}},"/v1/finance:remote/oauth2-exchange-token":{"post":{"operationId":"finance_remote_oauth2_exchange_token","summary":"Token","description":"POST /auth/oauth2/token","tags":["finance"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/employment-contracts-get-pending-changes":{"get":{"operationId":"finance_remote_employment_contracts_get_pending_changes","summary":"Get employment contract pending changes","description":"GET /v1/employment-contracts/{employment_id}/pending-changes","tags":["finance"],"parameters":[{"name":"employment_id","in":"query","required":true,"description":"Employment ID","schema":{"type":"string","description":"Employment ID"},"example":"93t3j-employment_id-9suej43"}],"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":"byok"}},"/v1/finance:remote/time-off-list-records":{"get":{"operationId":"finance_remote_time_off_list_records","summary":"List Time Off","description":"GET /v1/timeoff","tags":["finance"],"parameters":[{"name":"employment_id","in":"query","required":false,"description":"Only show time off for a specific employment","schema":{"type":"string","description":"Only show time off for a specific employment"},"example":"31b8e49b-aa1c-47af-849c-3d0a53e20e0d"},{"name":"timeoff_type","in":"query","required":false,"description":"Filter time off by its type","schema":{"type":"string","enum":["paid_time_off","sick_leave","public_holiday","unpaid_leave","extended_leave","in_lieu_time","maternity_leave","paternity_leave","parental_leave","bereavement","military_leave","other"],"description":"Filter time off by its type"},"example":"sick_leave"},{"name":"status","in":"query","required":false,"description":"Filter time off by its status","schema":{"type":"string","enum":["approved","cancelled","declined","requested","taken","cancel_requested"],"description":"Filter time off by its status"},"example":"approved"},{"name":"order","in":"query","required":false,"description":"Sort order","schema":{"type":"string","enum":["asc","desc"],"description":"Sort order"},"example":"asc"},{"name":"sort_by","in":"query","required":false,"description":"Field to sort by","schema":{"type":"string","enum":["timeoff_type","status"],"description":"Field to sort by"},"example":"timeoff_type"},{"name":"page","in":"query","required":false,"description":"Starts fetching records after the given page","schema":{"type":"integer","default":1,"description":"Starts fetching records after the given page"},"example":1},{"name":"page_size","in":"query","required":false,"description":"Number of items per page","schema":{"type":"integer","default":20,"description":"Number of items per page"},"example":20}],"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":"byok"}},"/v1/finance:remote/time-off-record-create":{"post":{"operationId":"finance_remote_time_off_record_create","summary":"Create Time Off","description":"POST /v1/timeoff","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/employments-get-employment-info":{"get":{"operationId":"finance_remote_employments_get_employment_info","summary":"Show employment","description":"GET /v1/employments/{employment_id}","tags":["finance"],"parameters":[{"name":"employment_id","in":"query","required":true,"description":"Employment ID","schema":{"type":"string","description":"Employment ID"},"example":"93t3j-employment-id-9suej43"}],"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":"byok"}},"/v1/finance:remote/employments-update-details":{"post":{"operationId":"finance_remote_employments_update_details","summary":"Update employment","description":"PUT /v1/employments/{employment_id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["employment_id"],"properties":{"employment_id":{"type":"string","description":"Employment ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/employments-update-data":{"post":{"operationId":"finance_remote_employments_update_data","summary":"Update employment","description":"PATCH /v1/employments/{employment_id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["employment_id"],"properties":{"employment_id":{"type":"string","description":"Employment ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/payslips-show-payslip":{"get":{"operationId":"finance_remote_payslips_show_payslip","summary":"Show payslip","description":"GET /v1/payslips/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Payslip ID","schema":{"type":"string","description":"Payslip ID"},"example":"93t3j-payslip-id-9suej43"}],"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":"byok"}},"/v1/finance:remote/recurring-incentives-delete-scheduled":{"post":{"operationId":"finance_remote_recurring_incentives_delete_scheduled","summary":"Delete a Recurring Incentive","description":"DELETE /v1/incentives/recurring/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Recurring Incentive ID"}}}}}},"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":"byok"}},"/v1/finance:remote/sandbox-employment-update":{"post":{"operationId":"finance_remote_sandbox_employment_update","summary":"Update employment","description":"PUT /v1/sandbox/employments/{employment_id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["employment_id"],"properties":{"employment_id":{"type":"string","description":"Employment ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/sandbox-update-employment-state":{"post":{"operationId":"finance_remote_sandbox_update_employment_state","summary":"Update employment","description":"PATCH /v1/sandbox/employments/{employment_id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["employment_id"],"properties":{"employment_id":{"type":"string","description":"Employment ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/employment-contracts-get-history":{"get":{"operationId":"finance_remote_employment_contracts_get_history","summary":"List Employment Contract.","description":"GET /v1/employment-contracts","tags":["finance"],"parameters":[{"name":"employment_id","in":"query","required":true,"description":"Employment ID","schema":{"type":"string","description":"Employment ID"},"example":"93t3j-employment_id-9suej43"}],"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":"byok"}},"/v1/finance:remote/resignation-download-letter":{"get":{"operationId":"finance_remote_resignation_download_letter","summary":"Download a resignation letter","description":"GET /v1/resignations/{employment_request_id}/resignation-letter","tags":["finance"],"parameters":[{"name":"employment_request_id","in":"query","required":true,"description":"The employment request ID","schema":{"type":"string","description":"The employment request ID"},"example":"3ab2e491-ad1c-47af-849c-3d0a53e20e0d"}],"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":"byok"}},"/v1/finance:remote/expenses-list-records":{"get":{"operationId":"finance_remote_expenses_list_records","summary":"List expenses","description":"GET /v1/expenses","tags":["finance"],"parameters":[{"name":"page","in":"query","required":false,"description":"Starts fetching records after the given page","schema":{"type":"integer","description":"Starts fetching records after the given page"},"example":1},{"name":"page_size","in":"query","required":false,"description":"Change the amount of records returned per page, defaults to 20, limited to 100","schema":{"type":"integer","description":"Change the amount of records returned per page, defaults to 20, limited to 100"},"example":30}],"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":"byok"}},"/v1/finance:remote/expenses-create-approved-expense":{"post":{"operationId":"finance_remote_expenses_create_approved_expense","summary":"Create expense","description":"POST /v1/expenses","tags":["finance"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/company-department-list":{"get":{"operationId":"finance_remote_company_department_list","summary":"List Company Departments","description":"GET /v1/company-departments","tags":["finance"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"string","description":"Company ID"},"example":"d2091b1e-b1a4-437a-91ea-2809ffbb6d59"},{"name":"paginate","in":"query","required":false,"description":"Paginate option. Default: true. When true, paginates response; otherwise, does not.","schema":{"type":"boolean","description":"Paginate option. Default: true. When true, paginates response; otherwise, does not."},"example":false},{"name":"page","in":"query","required":false,"description":"Starts fetching records after the given page","schema":{"type":"integer","default":1,"description":"Starts fetching records after the given page"},"example":1},{"name":"page_size","in":"query","required":false,"description":"Number of items per page","schema":{"type":"integer","default":20,"description":"Number of items per page"},"example":20}],"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":"byok"}},"/v1/finance:remote/company-department-create-new-department":{"post":{"operationId":"finance_remote_company_department_create_new_department","summary":"Create New Department","description":"POST /v1/company-departments","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/expenses-show-record":{"get":{"operationId":"finance_remote_expenses_show_record","summary":"Show expense","description":"GET /v1/expenses/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Expense ID","schema":{"type":"string","description":"Expense ID"}}],"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":"byok"}},"/v1/finance:remote/expenses-update-expense":{"post":{"operationId":"finance_remote_expenses_update_expense","summary":"Update an expense","description":"PUT /v1/expenses/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Expense ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/expenses-update-record":{"post":{"operationId":"finance_remote_expenses_update_record","summary":"Update an expense","description":"PATCH /v1/expenses/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Expense ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/identity-verification-get-employment-profile":{"get":{"operationId":"finance_remote_identity_verification_get_employment_profile","summary":"Get Employment Profile","description":"GET /v1/identity-verification/{employment_id}","tags":["finance"],"parameters":[{"name":"employment_id","in":"query","required":true,"description":"Employment ID","schema":{"type":"string","description":"Employment ID"},"example":"0a8s2d1-company-id-2e3f4th"}],"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":"byok"}},"/v1/finance:remote/company-managers-list-managers":{"get":{"operationId":"finance_remote_company_managers_list_managers","summary":"List Company Managers","description":"GET /v1/company-managers","tags":["finance"],"parameters":[{"name":"company_id","in":"query","required":false,"description":"A Company ID to filter the results (only applicable for Integration Partners).","schema":{"type":"string","description":"A Company ID to filter the results (only applicable for Integration Partners)."},"example":"0a8s2d1-company-id-2e3f4th"},{"name":"page","in":"query","required":false,"description":"Starts fetching records after the given page","schema":{"type":"integer","description":"Starts fetching records after the given page"},"example":1},{"name":"page_size","in":"query","required":false,"description":"Change the amount of records returned per page, defaults to 20, limited to 100","schema":{"type":"integer","description":"Change the amount of records returned per page, defaults to 20, limited to 100"},"example":30}],"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":"byok"}},"/v1/finance:remote/company-managers-create-invite":{"post":{"operationId":"finance_remote_company_managers_create_invite","summary":"Create and invite a Company Manager","description":"POST /v1/company-managers","tags":["finance"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/payslips-download-pdf":{"get":{"operationId":"finance_remote_payslips_download_pdf","summary":"Download payslip in the PDF format","description":"GET /v1/payslips/{payslip_id}/pdf","tags":["finance"],"parameters":[{"name":"payslip_id","in":"query","required":true,"description":"Payslip ID","schema":{"type":"string","description":"Payslip ID"},"example":"93t3j-payslip-id-9suej43"}],"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":"byok"}},"/v1/finance:remote/identity-get-token-info":{"get":{"operationId":"finance_remote_identity_get_token_info","summary":"Get token identity","description":"GET /v1/identity/current","tags":["finance"],"parameters":[],"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":"byok"}},"/v1/finance:remote/files-download-file":{"get":{"operationId":"finance_remote_files_download_file","summary":"Download file","description":"GET /v1/files/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"File ID","schema":{"type":"string","description":"File ID"},"example":"93t3j-file-id-9suej43"}],"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":"byok"}},"/v1/finance:remote/offboarding-list-requests":{"get":{"operationId":"finance_remote_offboarding_list_requests","summary":"List Offboarding","description":"GET /v1/offboardings","tags":["finance"],"parameters":[{"name":"employment_id","in":"query","required":false,"description":"Filter by Employment ID","schema":{"type":"string","description":"Filter by Employment ID"},"example":"93t3j-employment-id-9suej43"},{"name":"type","in":"query","required":false,"description":"Filter by offboarding type","schema":{"type":"string","description":"Filter by offboarding type"},"example":"paid"},{"name":"include_confidential","in":"query","required":false,"description":"By default, the results do not include confidential termination requests. Send `include_confidential=true` to include confidential…","schema":{"type":"string","description":"By default, the results do not include confidential termination requests. Send `include_confidential=true` to include confidential…"},"example":"true"},{"name":"page","in":"query","required":false,"description":"Starts fetching records after the given page","schema":{"type":"integer","description":"Starts fetching records after the given page"},"example":1},{"name":"page_size","in":"query","required":false,"description":"Change the amount of records returned per page, defaults to 20, limited to 100","schema":{"type":"integer","description":"Change the amount of records returned per page, defaults to 20, limited to 100"},"example":30}],"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":"byok"}},"/v1/finance:remote/offboarding-create-request":{"post":{"operationId":"finance_remote_offboarding_create_request","summary":"Create Offboarding","description":"POST /v1/offboardings","tags":["finance"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/benefit-offers-by-employment-list-by-employment":{"get":{"operationId":"finance_remote_benefit_offers_by_employment_list_by_employment","summary":"List Benefit Offers By Employment","description":"GET /v1/benefit-offers","tags":["finance"],"parameters":[],"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":"byok"}},"/v1/finance:remote/company-managers-show-user":{"get":{"operationId":"finance_remote_company_managers_show_user","summary":"Show company manager user","description":"GET /v1/company-managers/{user_id}","tags":["finance"],"parameters":[{"name":"user_id","in":"query","required":true,"description":"User ID","schema":{"type":"string","description":"User ID"},"example":"1a8s2d1-user-id-2e3f4tz"}],"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":"byok"}},"/v1/finance:remote/company-managers-delete-user":{"post":{"operationId":"finance_remote_company_managers_delete_user","summary":"Deletes a Company Manager user","description":"DELETE /v1/company-managers/{user_id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"User ID"}}}}}},"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":"byok"}},"/v1/finance:remote/custom-fields-show-value":{"get":{"operationId":"finance_remote_custom_fields_show_value","summary":"Show a custom field value","description":"GET /v1/custom-fields/{custom_field_id}/values/{employment_id}","tags":["finance"],"parameters":[{"name":"custom_field_id","in":"query","required":true,"description":"Custom field ID","schema":{"type":"string","description":"Custom field ID"}},{"name":"employment_id","in":"query","required":true,"description":"Employment ID","schema":{"type":"string","description":"Employment ID"}}],"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":"byok"}},"/v1/finance:remote/contract-amendments-show-single-request":{"get":{"operationId":"finance_remote_contract_amendments_show_single_request","summary":"Show Contract Amendment","description":"GET /v1/contract-amendments/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Contract amendment request ID","schema":{"type":"string","description":"Contract amendment request ID"},"example":"93t3j-contract_amendment_id-9suej43"}],"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":"byok"}},"/v1/finance:remote/companies-list-all":{"get":{"operationId":"finance_remote_companies_list_all","summary":"List all companies","description":"GET /v1/companies","tags":["finance"],"parameters":[],"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":"byok"}},"/v1/finance:remote/companies-create-new-company":{"post":{"operationId":"finance_remote_companies_create_new_company","summary":"Create a company","description":"POST /v1/companies","tags":["finance"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"action":{"type":"string","description":"Complementary action(s) to perform when creating a company: - `get_oauth_access_tokens` returns the user's access and refresh tokens -…"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/contract-amendments-check-automatability":{"post":{"operationId":"finance_remote_contract_amendments_check_automatability","summary":"Automatable Contract Amendment","description":"POST /v1/contract-amendments/automatable","tags":["finance"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/sandbox-create-employment-without-validations":{"post":{"operationId":"finance_remote_sandbox_create_employment_without_validations","summary":"Create employment","description":"POST /v1/sandbox/employments","tags":["finance"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/contract-amendments-get-form-schema":{"post":{"operationId":"finance_remote_contract_amendments_get_form_schema","summary":"Show form schema","description":"POST /v1/contract-amendments/schema","tags":["finance"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/resignation-validate-employment-request":{"post":{"operationId":"finance_remote_resignation_validate_employment_request","summary":"Validate resignation request","description":"PUT /v1/resignations/{employment_request_id}/validate","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["employment_request_id","body"],"properties":{"employment_request_id":{"type":"string","description":"The employment request ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/billing-documents-list":{"get":{"operationId":"finance_remote_billing_documents_list","summary":"List Billing Documents","description":"GET /v1/billing-documents","tags":["finance"],"parameters":[{"name":"period","in":"query","required":false,"description":"The month for the billing documents (in ISO-8601 format)","schema":{"type":"string","description":"The month for the billing documents (in ISO-8601 format)"},"example":"\"2023-01\""},{"name":"page","in":"query","required":false,"description":"Starts fetching records after the given page","schema":{"type":"integer","description":"Starts fetching records after the given page"},"example":1},{"name":"page_size","in":"query","required":false,"description":"Change the amount of records returned per page, defaults to 20, limited to 100","schema":{"type":"integer","description":"Change the amount of records returned per page, defaults to 20, limited to 100"},"example":30}],"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":"byok"}},"/v1/finance:remote/recurring-incentives-list-incentives":{"get":{"operationId":"finance_remote_recurring_incentives_list_incentives","summary":"List Recurring Incentive","description":"GET /v1/incentives/recurring","tags":["finance"],"parameters":[{"name":"status","in":"query","required":false,"description":"Filter by recurring incentive status: active or deactive.","schema":{"type":"string","description":"Filter by recurring incentive status: active or deactive."},"example":"active"},{"name":"type","in":"query","required":false,"description":"Filter by recurring incentive type.","schema":{"type":"string","description":"Filter by recurring incentive type."},"example":"meal_allowance"},{"name":"note","in":"query","required":false,"description":"Filter by recurring incentives that contain the value in their notes.","schema":{"type":"string","description":"Filter by recurring incentives that contain the value in their notes."},"example":"meal"},{"name":"page","in":"query","required":false,"description":"Starts fetching records after the given page","schema":{"type":"integer","description":"Starts fetching records after the given page"},"example":1},{"name":"page_size","in":"query","required":false,"description":"Change the amount of records returned per page, defaults to 20, limited to 100","schema":{"type":"integer","description":"Change the amount of records returned per page, defaults to 20, limited to 100"},"example":30}],"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":"byok"}},"/v1/finance:remote/recurring-incentives-create-monthly-incentive":{"post":{"operationId":"finance_remote_recurring_incentives_create_monthly_incentive","summary":"Create Recurring Incentive","description":"POST /v1/incentives/recurring","tags":["finance"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/countries-list-alphabetically":{"get":{"operationId":"finance_remote_countries_list_alphabetically","summary":"List countries","description":"GET /v1/countries","tags":["finance"],"parameters":[],"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":"byok"}},"/v1/finance:remote/cost-calculator-show-region-fields":{"get":{"operationId":"finance_remote_cost_calculator_show_region_fields","summary":"Show region fields","description":"GET /v1/cost-calculator/regions/{slug}/fields","tags":["finance"],"parameters":[{"name":"slug","in":"query","required":true,"description":"Slug","schema":{"type":"string","description":"Slug"}}],"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":"byok"}},"/v1/finance:remote/webhook-callbacks-delete-callback":{"post":{"operationId":"finance_remote_webhook_callbacks_delete_callback","summary":"Delete a Webhook Callback","description":"DELETE /v1/webhook-callbacks/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Webhook Callback ID"}}}}}},"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":"byok"}},"/v1/finance:remote/countries-list-holidays-by-year":{"get":{"operationId":"finance_remote_countries_list_holidays_by_year","summary":"List all holidays of a country","description":"GET /v1/countries/{country_code}/holidays/{year}","tags":["finance"],"parameters":[{"name":"country_code","in":"query","required":true,"description":"Country code according to ISO 3166-1 3-digit alphabetic codes","schema":{"type":"string","description":"Country code according to ISO 3166-1 3-digit alphabetic codes"},"example":"PRT"},{"name":"year","in":"query","required":true,"description":"Year for the holidays","schema":{"type":"string","description":"Year for the holidays"},"example":"2022"},{"name":"country_subdivision_code","in":"query","required":false,"description":"Country subdivision code according to ISO 3166-2 codes","schema":{"type":"string","description":"Country subdivision code according to ISO 3166-2 codes"},"example":"PT-10"}],"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":"byok"}},"/v1/finance:remote/billing-documents-download-pdf":{"get":{"operationId":"finance_remote_billing_documents_download_pdf","summary":"Download a billing document PDF","description":"GET /v1/billing-documents/{billing_document_id}/pdf","tags":["finance"],"parameters":[{"name":"billing_document_id","in":"query","required":true,"description":"The billing document's ID","schema":{"type":"string","description":"The billing document's ID"},"example":"93t3j-billing-doc-id-9suej43"}],"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":"byok"}},"/v1/finance:remote/files-upload-employment-file":{"post":{"operationId":"finance_remote_files_upload_employment_file","summary":"Upload file","description":"POST /v1/documents","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":"byok"}},"/v1/finance:remote/webhook-callbacks-register-callback":{"post":{"operationId":"finance_remote_webhook_callbacks_register_callback","summary":"Create a Webhook Callback","description":"POST /v1/webhook-callbacks","tags":["finance"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/cost-calculator-create-employment-estimation":{"post":{"operationId":"finance_remote_cost_calculator_create_employment_estimation","summary":"Creates a cost estimation of employments","description":"POST /v1/cost-calculator/estimation","tags":["finance"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/employments-invite-start-enrollment":{"post":{"operationId":"finance_remote_employments_invite_start_enrollment","summary":"Invite employment","description":"POST /v1/employments/{employment_id}/invite","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["employment_id"],"properties":{"employment_id":{"type":"string","description":"Employment ID"}}}}}},"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":"byok"}},"/v1/finance:remote/time-off-balances-show-balance":{"get":{"operationId":"finance_remote_time_off_balances_show_balance","summary":"Show Time Off Balance","description":"GET /v1/timeoff-balances/{employment_id}","tags":["finance"],"parameters":[{"name":"employment_id","in":"query","required":true,"description":"Employment ID for which to show the time off balance","schema":{"type":"string","description":"Employment ID for which to show the time off balance"},"example":"03675381-50c9-492d-b8ed-e84e99046091"}],"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":"byok"}},"/v1/finance:remote/billing-documents-show-details":{"get":{"operationId":"finance_remote_billing_documents_show_details","summary":"Show Billing Document","description":"GET /v1/billing-documents/{billing_document_id}","tags":["finance"],"parameters":[{"name":"billing_document_id","in":"query","required":true,"description":"The billing document's ID","schema":{"type":"string","description":"The billing document's ID"},"example":"93t3j-billing-doc-id-9suej43"}],"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":"byok"}},"/v1/finance:remote/expenses-download-receipt-by-id":{"get":{"operationId":"finance_remote_expenses_download_receipt_by_id","summary":"Download a receipt by id","description":"GET /v1/expenses/{expense_id}/receipts/{receipt_id}","tags":["finance"],"parameters":[{"name":"expense_id","in":"query","required":true,"description":"The expense ID","schema":{"type":"string","description":"The expense ID"},"example":"3ab2e491-ad1c-47af-849c-3d0a53e20e0d"},{"name":"receipt_id","in":"query","required":true,"description":"The receipt ID","schema":{"type":"string","description":"The receipt ID"},"example":"6ab2e49o-ad1c-47af-849c-3d0a53e21e0e"}],"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":"byok"}},"/v1/finance:remote/employments-list-all":{"get":{"operationId":"finance_remote_employments_list_all","summary":"List employments","description":"GET /v1/employments","tags":["finance"],"parameters":[{"name":"company_id","in":"query","required":false,"description":"Company ID","schema":{"type":"string","description":"Company ID"},"example":"93t3j-company-id-9suej43"},{"name":"email","in":"query","required":false,"description":"Filters the results by employments whose login email matches the value","schema":{"type":"string","description":"Filters the results by employments whose login email matches the value"},"example":"anna@example.com"},{"name":"status","in":"query","required":false,"description":"Filters the results by employments whose status matches the value","schema":{"type":"string","description":"Filters the results by employments whose status matches the value"},"example":"active"},{"name":"page","in":"query","required":false,"description":"Starts fetching records after the given page","schema":{"type":"integer","description":"Starts fetching records after the given page"},"example":1},{"name":"page_size","in":"query","required":false,"description":"Change the amount of records returned per page, defaults to 20, limited to 100","schema":{"type":"integer","description":"Change the amount of records returned per page, defaults to 20, limited to 100"},"example":30}],"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":"byok"}},"/v1/finance:remote/employments-create-employment":{"post":{"operationId":"finance_remote_employments_create_employment","summary":"Create employment","description":"POST /v1/employments","tags":["finance"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/cost-calculator-list-countries":{"get":{"operationId":"finance_remote_cost_calculator_list_countries","summary":"List countries","description":"GET /v1/cost-calculator/countries","tags":["finance"],"parameters":[],"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":"byok"}},"/v1/finance:remote/offboarding-show-request":{"get":{"operationId":"finance_remote_offboarding_show_request","summary":"Show Offboarding","description":"GET /v1/offboardings/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Offboarding request ID","schema":{"type":"string","description":"Offboarding request ID"}}],"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":"byok"}},"/v1/finance:remote/sandbox-trigger-webhook-callback":{"post":{"operationId":"finance_remote_sandbox_trigger_webhook_callback","summary":"Trigger a Webhook","description":"POST /v1/sandbox/webhook-callbacks/trigger","tags":["finance"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/time-off-list-types":{"get":{"operationId":"finance_remote_time_off_list_types","summary":"List Time Off Types","description":"GET /v1/timeoff/types","tags":["finance"],"parameters":[],"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":"byok"}},"/v1/finance:remote/companies-show-company":{"get":{"operationId":"finance_remote_companies_show_company","summary":"Show a company","description":"GET /v1/companies/{company_id}","tags":["finance"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"string","description":"Company ID"},"example":"0a8s2d1-company-id-2e3f4th"}],"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":"byok"}},"/v1/finance:remote/companies-update-company":{"post":{"operationId":"finance_remote_companies_update_company","summary":"Update a company","description":"PUT /v1/companies/{company_id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id"],"properties":{"company_id":{"type":"string","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/companies-update-company-2":{"post":{"operationId":"finance_remote_companies_update_company_2","summary":"Update a company","description":"PATCH /v1/companies/{company_id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id"],"properties":{"company_id":{"type":"string","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/employments-complete-onboarding":{"post":{"operationId":"finance_remote_employments_complete_onboarding","summary":"Complete onboarding","description":"POST /v1/ready","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/finance:remote/contract-amendments-approve-amendment":{"post":{"operationId":"finance_remote_contract_amendments_approve_amendment","summary":"Approve Contract Amendment","description":"PUT /v1/sandbox/contract-amendments/{contract_amendment_request_id}/approve","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["contract_amendment_request_id"],"properties":{"contract_amendment_request_id":{"type":"string","description":"Contract amendment request ID"}}}}}},"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":"byok"}},"/v1/finance:remote/countries-get-form-schema":{"get":{"operationId":"finance_remote_countries_get_form_schema","summary":"Show form schema","description":"GET /v1/countries/{country_code}/{form}","tags":["finance"],"parameters":[{"name":"country_code","in":"query","required":true,"description":"Country code according to ISO 3-digit alphabetic codes","schema":{"type":"string","description":"Country code according to ISO 3-digit alphabetic codes"},"example":"PRT"},{"name":"form","in":"query","required":true,"description":"Name of the desired form","schema":{"type":"string","description":"Name of the desired form"},"example":"address_details"},{"name":"employment_id","in":"query","required":false,"description":"Required for `contract_amendment` form","schema":{"type":"string","description":"Required for `contract_amendment` form"},"example":"663e0b79-c893-45ff-a1b2-f6dcabc098b5"}],"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":"byok"}},"/v1/finance:remote/sandbox-cancel-amendment-request":{"post":{"operationId":"finance_remote_sandbox_cancel_amendment_request","summary":"Cancel Contract Amendment","description":"PUT /v1/sandbox/contract-amendments/{contract_amendment_request_id}/cancel","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["contract_amendment_request_id"],"properties":{"contract_amendment_request_id":{"type":"string","description":"Contract amendment request ID"}}}}}},"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":"byok"}},"/v1/finance:remote/benefit-offers-list-country-summaries":{"get":{"operationId":"finance_remote_benefit_offers_list_country_summaries","summary":"List Benefit Offers","description":"GET /v1/benefit-offers/country-summaries","tags":["finance"],"parameters":[],"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":"byok"}}},"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"}}}}}}}