id
stringlengths
53
86
api_name
stringlengths
2
76
api_description
stringlengths
1
500
api_score
float64
0
10
endpoint_name
stringlengths
1
190
endpoint_description
stringlengths
0
500
response_status_code
int64
100
505
response_summary
stringlengths
1
68
response_json
stringlengths
6
50k
response_json_schema
stringlengths
14
150k
1e9731ff-f05a-46e0-9b9f-d45e4628e619/951ce8e0-5b69-45f9-9d8c-0c2f4159e2be/1/0
LimouCloud
LimouCloud APIs
0.2
Confirm Verification Code
Please send verification code in post request to confirm
200
New Example
{"success": true, "message": "Please Enter Your Password", "data": {"message": "send POST request to following url", "url": "/api/accounts/user/set-user-password/admin/4110", "redirect_url": "http://127.0.0.1:8000/account/reset-password/admin/4110"}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"success": {"type": "boolean"}, "message": {"type": "string"}, "data": {"type": "object", "properties": {"message": {"type": "string"}, "url": {"type": "string"}, "redirect_url": {"type": "string"}}, "required": ["message", "redirect_url", "url"]}}, "required": ["data", "message", "success"]}
1e9731ff-f05a-46e0-9b9f-d45e4628e619/0c4c3da6-01d8-4847-9f16-c2a464089fdc/0/0
LimouCloud
LimouCloud APIs
0.2
Update Work Status
Please send is_active in body params
200
New Example
{"success": true, "message": "User Work Status has been updated successfully to True", "data": null, "status_code": 200}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"success": {"type": "boolean"}, "message": {"type": "string"}, "data": {"type": "null"}, "status_code": {"type": "integer"}}, "required": ["data", "message", "status_code", "success"]}
1e9731ff-f05a-46e0-9b9f-d45e4628e619/0c4c3da6-01d8-4847-9f16-c2a464089fdc/1/0
LimouCloud
LimouCloud APIs
0.2
Update Work Status
Please send is_active in body params
401
New Example
{"detail": "Authentication credentials were not provided."}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "string"}}, "required": ["detail"]}
1e9731ff-f05a-46e0-9b9f-d45e4628e619/8a4222a5-68da-4235-bceb-7a2ee21b1bad/0/0
LimouCloud
LimouCloud APIs
0.2
Reset Forgotten password
Please reset the forgotten password by sending email in body
200
New Example
{"success": true, "message": "Please check your email for reset password", "data": {"username": "{username}", "redirect_url": "{some url}"}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"success": {"type": "boolean"}, "message": {"type": "string"}, "data": {"type": "object", "properties": {"username": {"type": "string"}, "redirect_url": {"type": "string"}}, "required": ["redirect_url", "username"]}}, "required": ["data", "message", "success"]}
1e9731ff-f05a-46e0-9b9f-d45e4628e619/6ffb7de1-792f-41a8-9822-a97e7014c5e1/0/0
LimouCloud
LimouCloud APIs
0.2
Set New Password
Set new password after getting code in email. Please do include username and code in URL path
200
New Example
{"success": true, "message": "Password Reset Successfully!", "data": {"redirect_url": "/account/login/?success=true&message=Password Reset Successfully!"}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"success": {"type": "boolean"}, "message": {"type": "string"}, "data": {"type": "object", "properties": {"redirect_url": {"type": "string"}}, "required": ["redirect_url"]}}, "required": ["data", "message", "success"]}
1e9731ff-f05a-46e0-9b9f-d45e4628e619/6ffb7de1-792f-41a8-9822-a97e7014c5e1/1/0
LimouCloud
LimouCloud APIs
0.2
Set New Password
Set new password after getting code in email. Please do include username and code in URL path
403
New Example
{"success": false, "message": "Incorrect information provided", "errors": ["Invalid code provided"]}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"success": {"type": "boolean"}, "message": {"type": "string"}, "errors": {"type": "array", "items": {"type": "string"}}}, "required": ["errors", "message", "success"]}
1e9731ff-f05a-46e0-9b9f-d45e4628e619/f3989cad-41ab-4219-9811-1a89b2ff0aa2/0/0
LimouCloud
LimouCloud APIs
0.2
Get all checklists
Get the Checklists created by driver
200
New Example
{"success": true, "message": "Operation Success!", "data": {"links": {"next": null, "previous": null}, "count": 0, "results": [{"id": 1, "driver": {"id": 3, "full_name": "Driver 123", "username": "driver123", "email": "[email protected]"}, "vehicle": {"id": 2, "name": "Rahim Diaz", "make": "ABC", "is_on_ride": false, "model_name": "Raja Wilcox", "year": "1984", "license": "ABC", "plate_number": "627", "vehicle_number": "861", "color": "RED", "vin": "abc", "insurance_company": "Craft and Sweeney LLC", "tabs_expiration_date": "04-Jul-2005", "inspection_expiration_date": "10-Jul-1999", "created_at": "2021-10-20T07:56:56.978570Z", "updated_at": "2021-11-18T12:25:55.148938Z", "milage": 47, "last_ride_started_milage": 66, "last_ride_ending_milage": 92, "vehicle_type": 2, "company": 2, "driver": 3}, "check_list_title": "Checklist #1", "other": "Deleniti in quas doloremque similique similique a doloremque voluptate unde est aute vel pariatur Repudiandae nesciunt", "created_at": "2021-11-17T15:12:29.340639Z", "updated_at": "2021-11-18T11:19:22.675820Z", "fluids": {"id": 1, "anti_freeze": "Good", "brake_fluid": "Good", "oil_level": "Refilled", "ps_fluid": "Refilled", "washer_fluid": "Unsatisfactory", "comments": "Sample Comment", "created_at": "2021-11-18T08:57:35.230980Z", "updated_at": "2021-11-18T08:57:55.445578Z"}, "lights": {"id": 1, "headlights_Lo": "Satisfactory", "headlights_Hi": "Satisfactory", "turn_signal_Lt": "Good", "turn_signal_Rt": "Satisfactory", "hazard_lights": "Replaced", "Interior_lights": "Satisfactory", "brake_lights": "Satisfactory", "comments": "Sample Comment", "created_at": "2021-11-18T11:17:38.460213Z", "updated_at": "2021-11-18T11:17:38.460304Z"}, "brake_and_tyres": {"id": 1, "brakes": "Good", "rims": "Replaced", "tyres": "Unsatisfactory", "wear": "Satisfactory", "comments": "Quidem fuga Amet quam at unde corrupti modi libero iste quae adipisci ducimus quo molestiae vel", "created_at": "2021-11-18T11:18:46.100911Z", "updated_at": "2021-11-18T11:18:52.695958Z"}, "misc": {"id": 1, "doors": "Good", "heater": "Unsatisfactory", "horn": "Replaced", "mirrors": "Refilled", "seats": "Replaced", "seat_belts": "Good", "steering": "Satisfactory", "windows": "Good", "windshield": "Good", "wiperblades": "Replaced", "comments": "Magni cillum accusamus exercitationem dolor quibusdam nisi nulla atque maiores praesentium sapiente do nihil eos consequatur ad ex", "created_at": "2021-11-18T11:18:34.270784Z", "updated_at": "2021-11-18T11:18:34.270843Z"}}]}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"success": {"type": "boolean"}, "message": {"type": "string"}, "data": {"type": "object", "properties": {"links": {"type": "object", "properties": {"next": {"type": "null"}, "previous": {"type": "null"}}, "required": ["next", "previous"]}, "count": {"type": "integer"}, "results": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer"}, "driver": {"type": "object", "properties": {"id": {"type": "integer"}, "full_name": {"type": "string"}, "username": {"type": "string"}, "email": {"type": "string"}}, "required": ["email", "full_name", "id", "username"]}, "vehicle": {"type": "object", "properties": {"id": {"type": "integer"}, "name": {"type": "string"}, "make": {"type": "string"}, "is_on_ride": {"type": "boolean"}, "model_name": {"type": "string"}, "year": {"type": "string"}, "license": {"type": "string"}, "plate_number": {"type": "string"}, "vehicle_number": {"type": "string"}, "color": {"type": "string"}, "vin": {"type": "string"}, "insurance_company": {"type": "string"}, "tabs_expiration_date": {"type": "string"}, "inspection_expiration_date": {"type": "string"}, "created_at": {"type": "string"}, "updated_at": {"type": "string"}, "milage": {"type": "integer"}, "last_ride_started_milage": {"type": "integer"}, "last_ride_ending_milage": {"type": "integer"}, "vehicle_type": {"type": "integer"}, "company": {"type": "integer"}, "driver": {"type": "integer"}}, "required": ["color", "company", "created_at", "driver", "id", "inspection_expiration_date", "insurance_company", "is_on_ride", "last_ride_ending_milage", "last_ride_started_milage", "license", "make", "milage", "model_name", "name", "plate_number", "tabs_expiration_date", "updated_at", "vehicle_number", "vehicle_type", "vin", "year"]}, "check_list_title": {"type": "string"}, "other": {"type": "string"}, "created_at": {"type": "string"}, "updated_at": {"type": "string"}, "fluids": {"type": "object", "properties": {"id": {"type": "integer"}, "anti_freeze": {"type": "string"}, "brake_fluid": {"type": "string"}, "oil_level": {"type": "string"}, "ps_fluid": {"type": "string"}, "washer_fluid": {"type": "string"}, "comments": {"type": "string"}, "created_at": {"type": "string"}, "updated_at": {"type": "string"}}, "required": ["anti_freeze", "brake_fluid", "comments", "created_at", "id", "oil_level", "ps_fluid", "updated_at", "washer_fluid"]}, "lights": {"type": "object", "properties": {"id": {"type": "integer"}, "headlights_Lo": {"type": "string"}, "headlights_Hi": {"type": "string"}, "turn_signal_Lt": {"type": "string"}, "turn_signal_Rt": {"type": "string"}, "hazard_lights": {"type": "string"}, "Interior_lights": {"type": "string"}, "brake_lights": {"type": "string"}, "comments": {"type": "string"}, "created_at": {"type": "string"}, "updated_at": {"type": "string"}}, "required": ["Interior_lights", "brake_lights", "comments", "created_at", "hazard_lights", "headlights_Hi", "headlights_Lo", "id", "turn_signal_Lt", "turn_signal_Rt", "updated_at"]}, "brake_and_tyres": {"type": "object", "properties": {"id": {"type": "integer"}, "brakes": {"type": "string"}, "rims": {"type": "string"}, "tyres": {"type": "string"}, "wear": {"type": "string"}, "comments": {"type": "string"}, "created_at": {"type": "string"}, "updated_at": {"type": "string"}}, "required": ["brakes", "comments", "created_at", "id", "rims", "tyres", "updated_at", "wear"]}, "misc": {"type": "object", "properties": {"id": {"type": "integer"}, "doors": {"type": "string"}, "heater": {"type": "string"}, "horn": {"type": "string"}, "mirrors": {"type": "string"}, "seats": {"type": "string"}, "seat_belts": {"type": "string"}, "steering": {"type": "string"}, "windows": {"type": "string"}, "windshield": {"type": "string"}, "wiperblades": {"type": "string"}, "comments": {"type": "string"}, "created_at": {"type": "string"}, "updated_at": {"type": "string"}}, "required": ["comments", "created_at", "doors", "heater", "horn", "id", "mirrors", "seat_belts", "seats", "steering", "updated_at", "windows", "windshield", "wiperblades"]}}, "required": ["brake_and_tyres", "check_list_title", "created_at", "driver", "fluids", "id", "lights", "misc", "other", "updated_at", "vehicle"]}}}, "required": ["count", "links", "results"]}}, "required": ["data", "message", "success"]}
1e9731ff-f05a-46e0-9b9f-d45e4628e619/f3989cad-41ab-4219-9811-1a89b2ff0aa2/1/0
LimouCloud
LimouCloud APIs
0.2
Get all checklists
Get the Checklists created by driver
401
New Example
{"detail": "Authentication credentials were not provided."}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "string"}}, "required": ["detail"]}
1e9731ff-f05a-46e0-9b9f-d45e4628e619/8d888d38-d2b3-421c-a8c4-daea6ccfcb8d/0/0
LimouCloud
LimouCloud APIs
0.2
Get assigned Vehicle
Get the Assigned vehicle to add its id in Checklist creation
401
New Example
{"detail": "Authentication credentials were not provided."}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "string"}}, "required": ["detail"]}
1e9731ff-f05a-46e0-9b9f-d45e4628e619/8d888d38-d2b3-421c-a8c4-daea6ccfcb8d/1/0
LimouCloud
LimouCloud APIs
0.2
Get assigned Vehicle
Get the Assigned vehicle to add its id in Checklist creation
200
New Example
{"success": true, "message": "Operation Success!", "data": {"id": 4, "name": "Accord", "make": "Honda", "is_on_ride": false, "model_name": "Honda Accord", "year": "1976", "license": "Anim", "plate_number": "512", "vehicle_number": "138", "color": "RED", "vin": "Voluptatem", "insurance_company": "Ortega Miranda Inc", "tabs_expiration_date": "11-Jul-1983", "inspection_expiration_date": "22-May-1987", "created_at": "2021-11-28T15:43:32.699197Z", "updated_at": "2021-11-28T15:51:56.837443Z", "milage": 12, "last_ride_started_milage": 83, "last_ride_ending_milage": 97, "vehicle_type": 1, "company": 1, "driver": 3}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"success": {"type": "boolean"}, "message": {"type": "string"}, "data": {"type": "object", "properties": {"id": {"type": "integer"}, "name": {"type": "string"}, "make": {"type": "string"}, "is_on_ride": {"type": "boolean"}, "model_name": {"type": "string"}, "year": {"type": "string"}, "license": {"type": "string"}, "plate_number": {"type": "string"}, "vehicle_number": {"type": "string"}, "color": {"type": "string"}, "vin": {"type": "string"}, "insurance_company": {"type": "string"}, "tabs_expiration_date": {"type": "string"}, "inspection_expiration_date": {"type": "string"}, "created_at": {"type": "string"}, "updated_at": {"type": "string"}, "milage": {"type": "integer"}, "last_ride_started_milage": {"type": "integer"}, "last_ride_ending_milage": {"type": "integer"}, "vehicle_type": {"type": "integer"}, "company": {"type": "integer"}, "driver": {"type": "integer"}}, "required": ["color", "company", "created_at", "driver", "id", "inspection_expiration_date", "insurance_company", "is_on_ride", "last_ride_ending_milage", "last_ride_started_milage", "license", "make", "milage", "model_name", "name", "plate_number", "tabs_expiration_date", "updated_at", "vehicle_number", "vehicle_type", "vin", "year"]}}, "required": ["data", "message", "success"]}
1e9731ff-f05a-46e0-9b9f-d45e4628e619/afdd8728-e6bc-46f1-9646-80036357203b/0/0
LimouCloud
LimouCloud APIs
0.2
Get Reservation by ID
Get Reservation by ID
401
New Example
{"detail": "Authentication credentials were not provided."}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "string"}}, "required": ["detail"]}
1e9731ff-f05a-46e0-9b9f-d45e4628e619/afdd8728-e6bc-46f1-9646-80036357203b/1/0
LimouCloud
LimouCloud APIs
0.2
Get Reservation by ID
Get Reservation by ID
200
New Example
{"success": true, "message": "Operation Success!", "data": {"id": 20, "client": {"id": 1, "primary_phone": "+1 (859) 144-2633", "secondary_phone": "+1 (859) 144-2633", "is_client_active": true, "is_corporate_client": true, "created_at": "2021-10-12T06:28:42.533285Z", "updated_at": "2021-10-12T06:28:54.832741Z", "company": 2, "userprofile": 3, "business_client": 1, "client_payment_info": 1}, "reservation_status": "CONFIRMED", "charge_by": "HOURLY RATE", "pay_by": "CREDIT CARD", "accepted_by_driver": true, "pickup_address": "xyz", "destination_address": "xyz", "pick_up_date": "2021-11-17", "pick_up_time": "16:00:32", "distance_in_miles": 1, "distance_covered_in_ride": 1, "total_hours": "24", "from_date": "2021-11-17", "to_date": "2021-11-17", "no_of_days": null, "rate_per_mile": null, "rate_per_day": null, "stops_between_ride": 0, "passenger_quantity": 1, "luggage_bags_quantity": 0, "car_seats": null, "client_notes": null, "driver_notes": null, "discount_percentage": 0, "gratuity_percentage": 0, "fuel_Surcharge_percentage": 0, "sales_tax_percentage": 0, "tolls": 0, "meet_and_greet": 0, "duration": null, "base_fare": null, "deposit_amount": 0, "balance_fare": 0, "balance_paid": false, "total_fare": 0, "company": 1, "service_type": 6, "vehicle_type": 1, "vehicle": 3, "driver": 3}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"success": {"type": "boolean"}, "message": {"type": "string"}, "data": {"type": "object", "properties": {"id": {"type": "integer"}, "client": {"type": "object", "properties": {"id": {"type": "integer"}, "primary_phone": {"type": "string"}, "secondary_phone": {"type": "string"}, "is_client_active": {"type": "boolean"}, "is_corporate_client": {"type": "boolean"}, "created_at": {"type": "string"}, "updated_at": {"type": "string"}, "company": {"type": "integer"}, "userprofile": {"type": "integer"}, "business_client": {"type": "integer"}, "client_payment_info": {"type": "integer"}}, "required": ["business_client", "client_payment_info", "company", "created_at", "id", "is_client_active", "is_corporate_client", "primary_phone", "secondary_phone", "updated_at", "userprofile"]}, "reservation_status": {"type": "string"}, "charge_by": {"type": "string"}, "pay_by": {"type": "string"}, "accepted_by_driver": {"type": "boolean"}, "pickup_address": {"type": "string"}, "destination_address": {"type": "string"}, "pick_up_date": {"type": "string"}, "pick_up_time": {"type": "string"}, "distance_in_miles": {"type": "integer"}, "distance_covered_in_ride": {"type": "integer"}, "total_hours": {"type": "string"}, "from_date": {"type": "string"}, "to_date": {"type": "string"}, "no_of_days": {"type": "null"}, "rate_per_mile": {"type": "null"}, "rate_per_day": {"type": "null"}, "stops_between_ride": {"type": "integer"}, "passenger_quantity": {"type": "integer"}, "luggage_bags_quantity": {"type": "integer"}, "car_seats": {"type": "null"}, "client_notes": {"type": "null"}, "driver_notes": {"type": "null"}, "discount_percentage": {"type": "integer"}, "gratuity_percentage": {"type": "integer"}, "fuel_Surcharge_percentage": {"type": "integer"}, "sales_tax_percentage": {"type": "integer"}, "tolls": {"type": "integer"}, "meet_and_greet": {"type": "integer"}, "duration": {"type": "null"}, "base_fare": {"type": "null"}, "deposit_amount": {"type": "integer"}, "balance_fare": {"type": "integer"}, "balance_paid": {"type": "boolean"}, "total_fare": {"type": "integer"}, "company": {"type": "integer"}, "service_type": {"type": "integer"}, "vehicle_type": {"type": "integer"}, "vehicle": {"type": "integer"}, "driver": {"type": "integer"}}, "required": ["accepted_by_driver", "balance_fare", "balance_paid", "base_fare", "car_seats", "charge_by", "client", "client_notes", "company", "deposit_amount", "destination_address", "discount_percentage", "distance_covered_in_ride", "distance_in_miles", "driver", "driver_notes", "duration", "from_date", "fuel_Surcharge_percentage", "gratuity_percentage", "id", "luggage_bags_quantity", "meet_and_greet", "no_of_days", "passenger_quantity", "pay_by", "pick_up_date", "pick_up_time", "pickup_address", "rate_per_day", "rate_per_mile", "reservation_status", "sales_tax_percentage", "service_type", "stops_between_ride", "to_date", "tolls", "total_fare", "total_hours", "vehicle", "vehicle_type"]}}, "required": ["data", "message", "success"]}
1e9731ff-f05a-46e0-9b9f-d45e4628e619/afdd8728-e6bc-46f1-9646-80036357203b/2/0
LimouCloud
LimouCloud APIs
0.2
Get Reservation by ID
Get Reservation by ID
404
New Example
{"detail": "Not found."}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "string"}}, "required": ["detail"]}
1e9731ff-f05a-46e0-9b9f-d45e4628e619/fa068b10-b29e-49d6-8018-dbb5dbd33a8f/0/0
LimouCloud
LimouCloud APIs
0.2
Get Reservations
get all driver related reservations
200
New Example
{"success": true, "message": "Operation Success!", "data": {"links": {"next": null, "previous": null}, "count": 0, "results": [{"id": 20, "client": {"id": 1, "primary_phone": "+1 (859) 144-2633", "secondary_phone": "+1 (859) 144-2633", "is_client_active": true, "is_corporate_client": true, "created_at": "2021-10-12T06:28:42.533285Z", "updated_at": "2021-10-12T06:28:54.832741Z", "company": 2, "userprofile": 3, "business_client": 1, "client_payment_info": 1}, "reservation_status": "CONFIRMED", "charge_by": "HOURLY RATE", "pay_by": "CREDIT CARD", "accepted_by_driver": true, "pickup_address": "xyz", "destination_address": "xyz", "pick_up_date": "2021-11-17", "pick_up_time": "16:00:32", "distance_in_miles": 1, "distance_covered_in_ride": 1, "total_hours": "24", "from_date": "2021-11-17", "to_date": "2021-11-17", "no_of_days": null, "rate_per_mile": null, "rate_per_day": null, "stops_between_ride": 0, "passenger_quantity": 1, "luggage_bags_quantity": 0, "car_seats": null, "client_notes": null, "driver_notes": null, "discount_percentage": 0, "gratuity_percentage": 0, "fuel_Surcharge_percentage": 0, "sales_tax_percentage": 0, "tolls": 0, "meet_and_greet": 0, "duration": null, "base_fare": null, "deposit_amount": 0, "balance_fare": 0, "balance_paid": false, "total_fare": 0, "company": 1, "service_type": 6, "vehicle_type": 1, "vehicle": 3, "driver": 3}]}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"success": {"type": "boolean"}, "message": {"type": "string"}, "data": {"type": "object", "properties": {"links": {"type": "object", "properties": {"next": {"type": "null"}, "previous": {"type": "null"}}, "required": ["next", "previous"]}, "count": {"type": "integer"}, "results": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer"}, "client": {"type": "object", "properties": {"id": {"type": "integer"}, "primary_phone": {"type": "string"}, "secondary_phone": {"type": "string"}, "is_client_active": {"type": "boolean"}, "is_corporate_client": {"type": "boolean"}, "created_at": {"type": "string"}, "updated_at": {"type": "string"}, "company": {"type": "integer"}, "userprofile": {"type": "integer"}, "business_client": {"type": "integer"}, "client_payment_info": {"type": "integer"}}, "required": ["business_client", "client_payment_info", "company", "created_at", "id", "is_client_active", "is_corporate_client", "primary_phone", "secondary_phone", "updated_at", "userprofile"]}, "reservation_status": {"type": "string"}, "charge_by": {"type": "string"}, "pay_by": {"type": "string"}, "accepted_by_driver": {"type": "boolean"}, "pickup_address": {"type": "string"}, "destination_address": {"type": "string"}, "pick_up_date": {"type": "string"}, "pick_up_time": {"type": "string"}, "distance_in_miles": {"type": "integer"}, "distance_covered_in_ride": {"type": "integer"}, "total_hours": {"type": "string"}, "from_date": {"type": "string"}, "to_date": {"type": "string"}, "no_of_days": {"type": "null"}, "rate_per_mile": {"type": "null"}, "rate_per_day": {"type": "null"}, "stops_between_ride": {"type": "integer"}, "passenger_quantity": {"type": "integer"}, "luggage_bags_quantity": {"type": "integer"}, "car_seats": {"type": "null"}, "client_notes": {"type": "null"}, "driver_notes": {"type": "null"}, "discount_percentage": {"type": "integer"}, "gratuity_percentage": {"type": "integer"}, "fuel_Surcharge_percentage": {"type": "integer"}, "sales_tax_percentage": {"type": "integer"}, "tolls": {"type": "integer"}, "meet_and_greet": {"type": "integer"}, "duration": {"type": "null"}, "base_fare": {"type": "null"}, "deposit_amount": {"type": "integer"}, "balance_fare": {"type": "integer"}, "balance_paid": {"type": "boolean"}, "total_fare": {"type": "integer"}, "company": {"type": "integer"}, "service_type": {"type": "integer"}, "vehicle_type": {"type": "integer"}, "vehicle": {"type": "integer"}, "driver": {"type": "integer"}}, "required": ["accepted_by_driver", "balance_fare", "balance_paid", "base_fare", "car_seats", "charge_by", "client", "client_notes", "company", "deposit_amount", "destination_address", "discount_percentage", "distance_covered_in_ride", "distance_in_miles", "driver", "driver_notes", "duration", "from_date", "fuel_Surcharge_percentage", "gratuity_percentage", "id", "luggage_bags_quantity", "meet_and_greet", "no_of_days", "passenger_quantity", "pay_by", "pick_up_date", "pick_up_time", "pickup_address", "rate_per_day", "rate_per_mile", "reservation_status", "sales_tax_percentage", "service_type", "stops_between_ride", "to_date", "tolls", "total_fare", "total_hours", "vehicle", "vehicle_type"]}}}, "required": ["count", "links", "results"]}}, "required": ["data", "message", "success"]}
1e9731ff-f05a-46e0-9b9f-d45e4628e619/fa068b10-b29e-49d6-8018-dbb5dbd33a8f/1/0
LimouCloud
LimouCloud APIs
0.2
Get Reservations
get all driver related reservations
401
New Example
{"details": "unauthorized"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"details": {"type": "string"}}, "required": ["details"]}
1e9731ff-f05a-46e0-9b9f-d45e4628e619/4e09da4f-c593-4ff2-9649-0635fb555d7f/0/0
LimouCloud
LimouCloud APIs
0.2
Login
Account login via username and password
403
New Example
{"success": false, "message": "User not found!", "errors": null}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"success": {"type": "boolean"}, "message": {"type": "string"}, "errors": {"type": "null"}}, "required": ["errors", "message", "success"]}
1e9731ff-f05a-46e0-9b9f-d45e4628e619/4e09da4f-c593-4ff2-9649-0635fb555d7f/1/0
LimouCloud
LimouCloud APIs
0.2
Login
Account login via username and password
200
New Example
{"success": true, "message": "User Login Successfully", "data": {"token": "{token}", "user_profile": {"id": 6, "address": {"id": 2, "address": "ABC", "city": "Abc", "state": "Abc", "country": "Abc", "zip_code": 1234}, "user": {"first_name": "Driver", "last_name": "Test", "username": "driver123", "email": "[email protected]"}, "config": {"dark_mode": true, "location": false, "new_trips_notifications": true, "notification": true}, "phone": "+1234567890", "email_verified": true, "verification_code": 0, "role": "DRIVER", "created_at": "2021-11-02T08:26:46.154496Z", "updated_at": "2021-11-02T16:32:14.445657Z", "step_count": 1, "is_active": false}}, "status_code": 200}
{"success": true, "status code": 200, "message": "User Login Successfully", "data": {"token": "9bbdb4d84e4f13399daf6bdc6215d1d20f0f04ff", "user_profile": {"id": 6, "address": {"id": 2, "address": "BOR Bismillah block 3 H# 10", "city": "Lahore", "state": "Punjab", "country": "Pakistan", "zip_code": 54000}, "user": {"first_name": "Driver", "last_name": "123", "username": "driver123", "email": "[email protected]"}, "config": {"dark_mode": true, "location": false, "new_trips_notifications": true, "notification": true}, "phone": "+923218337902", "email_verified": true, "verification_code": 0, "role": "DRIVER", "created_at": "2021-11-02T08:26:46.154496Z", "updated_at": "2021-11-02T16:32:14.445657Z", "step_count": 1, "is_active": false}}}
6a434400-e0fe-4b91-940a-6c12b8a984c1/e2af4dca-51ed-49fe-bec8-a8af8247c325/0/0
Messages Generation Tool
Generate emails or connection requests based on your prospect’s Linkedin profile. This tool is especially powerful for sales and marketing teams.
null
generateLinkedinMessages
Generate 5 different hyper personalized Linkedin connection messages instantly. You also have access to key data about your prospect easily.
200
Response
{"current_company": {"company_name": "Queens'\u200b College, Cambridge", "title": "President"}, "education": {"degree": "Doctorate", "fields_of_study": ["Economics"], "school_name": "Oxford University"}, "first_name": "Mohamed", "industry": "Higher Education", "last_name": "El-Erian", "location": "Cambridge, England, United Kingdom", "output_1": "It goes without saying that your experience and qualifications are impressive. I\u2019d be very happy to connect.", "output_2": "Whilst reading your bio, I noticed that you\u2019re a professor at the Wharton School and a senior fellow of the University of Pennsylvania. I would like to know more about your work in finance, and what you believe is the future of the global economy.", "output_3": "Your experience in the financial services industry, and your work in the academic world, makes you a great fit for Queens' College. I am glad to see that you are part of the advisory board of Gramercy Fund Management. I\u2019d love to connect with you.", "output_4": "It\u2019s obvious that you\u2019ve been very successful in your career. I think that\u2019s great, you deserve every success and I wish you all the best.", "output_5": "I loved reading about your experience at Queens' College, Cambridge. I think it's really important to be driven by solving big problems. I'm very glad to see your efforts in leading cross-functional teams and delivering excellent software products for WeWin. Let's connect, cheers!", "skills": ["Finance", "Economics", "Emerging Markets", "Management", "Investment Strategies", "Research", "Financial Advisory", "Asset Management", "Portfolio Management"]}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"current_company": {"type": "object", "properties": {"company_name": {"type": "string"}, "title": {"type": "string"}}, "required": ["company_name", "title"]}, "education": {"type": "object", "properties": {"degree": {"type": "string"}, "fields_of_study": {"type": "array", "items": {"type": "string"}}, "school_name": {"type": "string"}}, "required": ["degree", "fields_of_study", "school_name"]}, "first_name": {"type": "string"}, "industry": {"type": "string"}, "last_name": {"type": "string"}, "location": {"type": "string"}, "output_1": {"type": "string"}, "output_2": {"type": "string"}, "output_3": {"type": "string"}, "output_4": {"type": "string"}, "output_5": {"type": "string"}, "skills": {"type": "array", "items": {"type": "string"}}}, "required": ["current_company", "education", "first_name", "industry", "last_name", "location", "output_1", "output_2", "output_3", "output_4", "output_5", "skills"]}
6a434400-e0fe-4b91-940a-6c12b8a984c1/15cccb74-3ec0-4132-9e4a-45f377c8321a/0/0
Messages Generation Tool
Generate emails or connection requests based on your prospect’s Linkedin profile. This tool is especially powerful for sales and marketing teams.
null
generateEmailOpeners
Generate 5 different hyper-personalized email openers instantly. You also have access to key data about your prospect easily.
200
Response
{"current_company": {"company_name": "JLo Beauty", "title": "Founder"}, "education": null, "first_name": "Jennifer", "industry": "Entertainment", "last_name": "Lopez", "location": "Los Angeles, California, United States", "output_1": "I must say, your outstanding track record is impressive. I admire your achievements in the fashion industry, as well as your humanitarian work.", "output_2": "I must say, I enjoyed reading your bio - it\u2019s very interesting and I got a lot of information about you. I hope that you will continue to do great things in the future and inspire us all.", "output_3": "I love the fact that you\u2019re a mom. I think it\u2019s an important thing to mention in your bio, especially when you have so many other successful ventures and achievements. I also love that you\u2019re a partner, actor, singer, fashion designer and humanitarian. I think it shows that you have so many interests and passions yet are still able to balance them all", "output_4": "It\u2019s obvious that you\u2019re a very busy woman. I admire that you\u2019re involved in charity and humanitarian work, it\u2019s very admirable. I also like your fashion sense and your sense of style.", "output_5": "I went over your LinkedIn profile and I saw that you\u2019re a mother, partner, actor, singer, film & television producer, fashion designer, bestselling author and humanitarian. I think it's awesome!", "skills": ["Film", "Acting", "Music Videos", "Theatre", "Music", "Music Industry", "Singing", "Dance", "Video", "Choreography", "Television", "Feature Films", "Entertainment", "Film Production", "Entrepreneurship"]}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"current_company": {"type": "object", "properties": {"company_name": {"type": "string"}, "title": {"type": "string"}}, "required": ["company_name", "title"]}, "education": {"type": "null"}, "first_name": {"type": "string"}, "industry": {"type": "string"}, "last_name": {"type": "string"}, "location": {"type": "string"}, "output_1": {"type": "string"}, "output_2": {"type": "string"}, "output_3": {"type": "string"}, "output_4": {"type": "string"}, "output_5": {"type": "string"}, "skills": {"type": "array", "items": {"type": "string"}}}, "required": ["current_company", "education", "first_name", "industry", "last_name", "location", "output_1", "output_2", "output_3", "output_4", "output_5", "skills"]}
f38cac71-acf9-47be-9738-a4191e15b288/ef95bf73-3a98-4e80-94c9-9c889ee6462a/0/0
Git Pager
Easility perform CRUD (Create, Read, Update and Delete) operations on any Github repo!
null
List folder contents
Lists all of the contents of a specific Github repo.
200
Response
[{"name": ".github", "path": ".github", "sha": "7e834fe3bce0ca4313938481e1610c30cb481735", "size": 0, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/.github?ref=main", "html_url": "https://github.com/gina305/Switch-Code/tree/main/.github", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/trees/7e834fe3bce0ca4313938481e1610c30cb481735", "download_url": null, "type": "dir", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/.github?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/trees/7e834fe3bce0ca4313938481e1610c30cb481735", "html": "https://github.com/gina305/Switch-Code/tree/main/.github"}}, {"name": "<h1>this i my new eader<", "path": "<h1>this i my new eader<", "sha": "58a7dd95501ef93760c4d4171322b2eaeeeb17a1", "size": 0, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/%3Ch1%3Ethis%20i%20my%20new%20eader%3C?ref=main", "html_url": "https://github.com/gina305/Switch-Code/tree/main/%3Ch1%3Ethis%20i%20my%20new%20eader%3C", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/trees/58a7dd95501ef93760c4d4171322b2eaeeeb17a1", "download_url": null, "type": "dir", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/%3Ch1%3Ethis%20i%20my%20new%20eader%3C?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/trees/58a7dd95501ef93760c4d4171322b2eaeeeb17a1", "html": "https://github.com/gina305/Switch-Code/tree/main/%3Ch1%3Ethis%20i%20my%20new%20eader%3C"}}, {"name": "Copy of Gina Napier", "path": "Copy of Gina Napier", "sha": "34b054d4ce3cc3a677665eb1895462ae4a3be8e8", "size": 128, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/Copy%20of%20Gina%20Napier?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/Copy%20of%20Gina%20Napier", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/34b054d4ce3cc3a677665eb1895462ae4a3be8e8", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/Copy%20of%20Gina%20Napier?token=ABLKXDKPNCZ5IWFYGACSOVTDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/Copy%20of%20Gina%20Napier?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/34b054d4ce3cc3a677665eb1895462ae4a3be8e8", "html": "https://github.com/gina305/Switch-Code/blob/main/Copy%20of%20Gina%20Napier"}}, {"name": "CopyofGCopy.html", "path": "CopyofGCopy.html", "sha": "1c34df0cb8280f94d35fcd72fa48b36106d6bc39", "size": 8409, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/CopyofGCopy.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/CopyofGCopy.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/1c34df0cb8280f94d35fcd72fa48b36106d6bc39", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/CopyofGCopy.html?token=ABLKXDLBIO6BG6JKZ6EH7HLDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/CopyofGCopy.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/1c34df0cb8280f94d35fcd72fa48b36106d6bc39", "html": "https://github.com/gina305/Switch-Code/blob/main/CopyofGCopy.html"}}, {"name": "PATH", "path": "PATH", "sha": "0d5a690c8fad5e605a6e8766295d9d459d65de42", "size": 20, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/PATH?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/PATH", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/0d5a690c8fad5e605a6e8766295d9d459d65de42", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/PATH?token=ABLKXDL24UVAPGHVBTLZT3DDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/PATH?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/0d5a690c8fad5e605a6e8766295d9d459d65de42", "html": "https://github.com/gina305/Switch-Code/blob/main/PATH"}}, {"name": "PAThee.html", "path": "PAThee.html", "sha": "6dd65627ce5f77bc7f6954bbde60c7340de77292", "size": 401, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/PAThee.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/PAThee.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/6dd65627ce5f77bc7f6954bbde60c7340de77292", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/PAThee.html?token=ABLKXDJBW57HTSJOL24UH63DIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/PAThee.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/6dd65627ce5f77bc7f6954bbde60c7340de77292", "html": "https://github.com/gina305/Switch-Code/blob/main/PAThee.html"}}, {"name": "PATkfhee.html", "path": "PATkfhee.html", "sha": "6dd65627ce5f77bc7f6954bbde60c7340de77292", "size": 401, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/PATkfhee.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/PATkfhee.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/6dd65627ce5f77bc7f6954bbde60c7340de77292", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/PATkfhee.html?token=ABLKXDJDQNJI3H3447PTWF3DIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/PATkfhee.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/6dd65627ce5f77bc7f6954bbde60c7340de77292", "html": "https://github.com/gina305/Switch-Code/blob/main/PATkfhee.html"}}, {"name": "Powerpub.png", "path": "Powerpub.png", "sha": "1426269f91c686d4dfa16f10b2229a34134f8576", "size": 18846, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/Powerpub.png?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/Powerpub.png", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/1426269f91c686d4dfa16f10b2229a34134f8576", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/Powerpub.png?token=ABLKXDIAHC7KFJKLIJJOP23DIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/Powerpub.png?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/1426269f91c686d4dfa16f10b2229a34134f8576", "html": "https://github.com/gina305/Switch-Code/blob/main/Powerpub.png"}}, {"name": "aablgog.html", "path": "aablgog.html", "sha": "d5431bd19431a8ea9be94268df522caf03b7693a", "size": 13, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/aablgog.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/aablgog.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/d5431bd19431a8ea9be94268df522caf03b7693a", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/aablgog.html?token=ABLKXDLDIXK3QOZZCWXJQE3DIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/aablgog.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/d5431bd19431a8ea9be94268df522caf03b7693a", "html": "https://github.com/gina305/Switch-Code/blob/main/aablgog.html"}}, {"name": "aablog.html", "path": "aablog.html", "sha": "d5431bd19431a8ea9be94268df522caf03b7693a", "size": 13, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/aablog.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/aablog.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/d5431bd19431a8ea9be94268df522caf03b7693a", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/aablog.html?token=ABLKXDNNQEDYIUZGDREMLE3DIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/aablog.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/d5431bd19431a8ea9be94268df522caf03b7693a", "html": "https://github.com/gina305/Switch-Code/blob/main/aablog.html"}}, {"name": "alffpha1.html", "path": "alffpha1.html", "sha": "3a3f4dba4e86acaba9803cb1e16ae9d7747c6c86", "size": 15, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/alffpha1.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/alffpha1.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/3a3f4dba4e86acaba9803cb1e16ae9d7747c6c86", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/alffpha1.html?token=ABLKXDMEPO222FDLDBB7XZ3DIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/alffpha1.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/3a3f4dba4e86acaba9803cb1e16ae9d7747c6c86", "html": "https://github.com/gina305/Switch-Code/blob/main/alffpha1.html"}}, {"name": "assets", "path": "assets", "sha": "64b6f5057d3423c913b310b438605f7ef63a4b31", "size": 0, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/assets?ref=main", "html_url": "https://github.com/gina305/Switch-Code/tree/main/assets", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/trees/64b6f5057d3423c913b310b438605f7ef63a4b31", "download_url": null, "type": "dir", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/assets?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/trees/64b6f5057d3423c913b310b438605f7ef63a4b31", "html": "https://github.com/gina305/Switch-Code/tree/main/assets"}}, {"name": "atesting.html", "path": "atesting.html", "sha": "3a3f4dba4e86acaba9803cb1e16ae9d7747c6c86", "size": 15, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/atesting.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/atesting.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/3a3f4dba4e86acaba9803cb1e16ae9d7747c6c86", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/atesting.html?token=ABLKXDNJODNLYUTR5VJDM6DDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/atesting.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/3a3f4dba4e86acaba9803cb1e16ae9d7747c6c86", "html": "https://github.com/gina305/Switch-Code/blob/main/atesting.html"}}, {"name": "blog.html", "path": "blog.html", "sha": "fc232b2ce8bc394354c72817ad7e42fd32cb7c68", "size": 10243, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/blog.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/blog.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/fc232b2ce8bc394354c72817ad7e42fd32cb7c68", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/blog.html?token=ABLKXDP3KMLQMZE5MOLIJZLDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/blog.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/fc232b2ce8bc394354c72817ad7e42fd32cb7c68", "html": "https://github.com/gina305/Switch-Code/blob/main/blog.html"}}, {"name": "bruh.html", "path": "bruh.html", "sha": "8ca08c67df3b24cb2afb4012555c0189e48fa389", "size": 1220, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/bruh.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/bruh.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/8ca08c67df3b24cb2afb4012555c0189e48fa389", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/bruh.html?token=ABLKXDJ6FPAQMZ4EBMVBOQDDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/bruh.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/8ca08c67df3b24cb2afb4012555c0189e48fa389", "html": "https://github.com/gina305/Switch-Code/blob/main/bruh.html"}}, {"name": "cali-insider.html", "path": "cali-insider.html", "sha": "e3a1c566b45857cd9c251df9f4243de12d49dcee", "size": 39, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/cali-insider.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/cali-insider.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/e3a1c566b45857cd9c251df9f4243de12d49dcee", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/cali-insider.html?token=ABLKXDNVV3H6A4ZKM5WGHVTDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/cali-insider.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/e3a1c566b45857cd9c251df9f4243de12d49dcee", "html": "https://github.com/gina305/Switch-Code/blob/main/cali-insider.html"}}, {"name": "filepath.html", "path": "filepath.html", "sha": "56f7951d1ce6e7d96b3d43049585e1071716ad07", "size": 3375, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/filepath.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/filepath.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/56f7951d1ce6e7d96b3d43049585e1071716ad07", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/filepath.html?token=ABLKXDOJJ3DPOP7MTV2MGL3DIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/filepath.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/56f7951d1ce6e7d96b3d43049585e1071716ad07", "html": "https://github.com/gina305/Switch-Code/blob/main/filepath.html"}}, {"name": "images", "path": "images", "sha": "464fdc99e03c52741f1956576666b7235ab5d0c7", "size": 0, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/images?ref=main", "html_url": "https://github.com/gina305/Switch-Code/tree/main/images", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/trees/464fdc99e03c52741f1956576666b7235ab5d0c7", "download_url": null, "type": "dir", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/images?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/trees/464fdc99e03c52741f1956576666b7235ab5d0c7", "html": "https://github.com/gina305/Switch-Code/tree/main/images"}}, {"name": "index.html", "path": "index.html", "sha": "07d23728ee3d106f762b1df9ed4174e4123d9f3a", "size": 25076, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/index.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/index.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/07d23728ee3d106f762b1df9ed4174e4123d9f3a", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/index.html?token=ABLKXDIIVI6H7ZEKCJBLAZDDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/index.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/07d23728ee3d106f762b1df9ed4174e4123d9f3a", "html": "https://github.com/gina305/Switch-Code/blob/main/index.html"}}, {"name": "loler.html", "path": "loler.html", "sha": "3a3f4dba4e86acaba9803cb1e16ae9d7747c6c86", "size": 15, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/loler.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/loler.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/3a3f4dba4e86acaba9803cb1e16ae9d7747c6c86", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/loler.html?token=ABLKXDLGRA6BQ4TH6YSV4IDDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/loler.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/3a3f4dba4e86acaba9803cb1e16ae9d7747c6c86", "html": "https://github.com/gina305/Switch-Code/blob/main/loler.html"}}, {"name": "lolmjher.html", "path": "lolmjher.html", "sha": "3a3f4dba4e86acaba9803cb1e16ae9d7747c6c86", "size": 15, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/lolmjher.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/lolmjher.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/3a3f4dba4e86acaba9803cb1e16ae9d7747c6c86", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/lolmjher.html?token=ABLKXDNN2VJG7CSHMWFSRGLDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/lolmjher.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/3a3f4dba4e86acaba9803cb1e16ae9d7747c6c86", "html": "https://github.com/gina305/Switch-Code/blob/main/lolmjher.html"}}, {"name": "mycustomtitle2.html", "path": "mycustomtitle2.html", "sha": "3eae00b7aa2ec09cbad5b46e364dda57c75dc0df", "size": 27, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/mycustomtitle2.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/mycustomtitle2.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/3eae00b7aa2ec09cbad5b46e364dda57c75dc0df", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/mycustomtitle2.html?token=ABLKXDK6TTDRQ47SFL7U5JLDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/mycustomtitle2.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/3eae00b7aa2ec09cbad5b46e364dda57c75dc0df", "html": "https://github.com/gina305/Switch-Code/blob/main/mycustomtitle2.html"}}, {"name": "page2.html", "path": "page2.html", "sha": "7ae501b283ee9eed4eeffeb4cc20fc09ddf7e88d", "size": 12188, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/page2.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/page2.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/7ae501b283ee9eed4eeffeb4cc20fc09ddf7e88d", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/page2.html?token=ABLKXDODCQMGJJNG73WK3DDDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/page2.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/7ae501b283ee9eed4eeffeb4cc20fc09ddf7e88d", "html": "https://github.com/gina305/Switch-Code/blob/main/page2.html"}}, {"name": "page22.html", "path": "page22.html", "sha": "f2e72e5e5b27330c8e743daa7987d9f8333b2f83", "size": 9, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/page22.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/page22.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/f2e72e5e5b27330c8e743daa7987d9f8333b2f83", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/page22.html?token=ABLKXDK7GRQTEWRXSMUVCV3DIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/page22.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/f2e72e5e5b27330c8e743daa7987d9f8333b2f83", "html": "https://github.com/gina305/Switch-Code/blob/main/page22.html"}}, {"name": "page3.html", "path": "page3.html", "sha": "f5b1f56ab270d48fe8fe07e3f746c0a51b290763", "size": 12648, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/page3.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/page3.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/f5b1f56ab270d48fe8fe07e3f746c0a51b290763", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/page3.html?token=ABLKXDMYG5WBDI3UOIQJWVDDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/page3.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/f5b1f56ab270d48fe8fe07e3f746c0a51b290763", "html": "https://github.com/gina305/Switch-Code/blob/main/page3.html"}}, {"name": "page6.html", "path": "page6.html", "sha": "f1a0b98ee37d5b373e5e376a306b45c30ab43026", "size": 27055, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/page6.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/page6.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/f1a0b98ee37d5b373e5e376a306b45c30ab43026", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/page6.html?token=ABLKXDOG4DOFSZ4QWWHPVQLDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/page6.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/f1a0b98ee37d5b373e5e376a306b45c30ab43026", "html": "https://github.com/gina305/Switch-Code/blob/main/page6.html"}}, {"name": "page7.html", "path": "page7.html", "sha": "8c5713f9be59f4a7a063b53d3dfe307696ae234f", "size": 9589, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/page7.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/page7.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/8c5713f9be59f4a7a063b53d3dfe307696ae234f", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/page7.html?token=ABLKXDM72MXJTE4DPR4WCLDDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/page7.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/8c5713f9be59f4a7a063b53d3dfe307696ae234f", "html": "https://github.com/gina305/Switch-Code/blob/main/page7.html"}}, {"name": "page8.html", "path": "page8.html", "sha": "46373fc1509af6051094c007d61f0bb31fea4679", "size": 16069, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/page8.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/page8.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/46373fc1509af6051094c007d61f0bb31fea4679", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/page8.html?token=ABLKXDJXVRCGCLMOLX73MC3DIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/page8.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/46373fc1509af6051094c007d61f0bb31fea4679", "html": "https://github.com/gina305/Switch-Code/blob/main/page8.html"}}, {"name": "pricing.html", "path": "pricing.html", "sha": "2420b785f3491aa39d7b8766bb0e8c5f6d6d2775", "size": 60227, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/pricing.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/pricing.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/2420b785f3491aa39d7b8766bb0e8c5f6d6d2775", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/pricing.html?token=ABLKXDNSKM2ZZ5XQB7NVOGLDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/pricing.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/2420b785f3491aa39d7b8766bb0e8c5f6d6d2775", "html": "https://github.com/gina305/Switch-Code/blob/main/pricing.html"}}, {"name": "project.mobirise", "path": "project.mobirise", "sha": "b404bbec57e30328c0db98a38aa9f325531d4d40", "size": 556610, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/project.mobirise?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/project.mobirise", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/b404bbec57e30328c0db98a38aa9f325531d4d40", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/project.mobirise?token=ABLKXDP26E2HQHK4C2UWEG3DIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/project.mobirise?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/b404bbec57e30328c0db98a38aa9f325531d4d40", "html": "https://github.com/gina305/Switch-Code/blob/main/project.mobirise"}}, {"name": "robots.txt", "path": "robots.txt", "sha": "6cd423d4592dd407d524293f67d7812aa535dd0c", "size": 33, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/robots.txt?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/robots.txt", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/6cd423d4592dd407d524293f67d7812aa535dd0c", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/robots.txt?token=ABLKXDLUIONEUZK2ACX7PRTDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/robots.txt?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/6cd423d4592dd407d524293f67d7812aa535dd0c", "html": "https://github.com/gina305/Switch-Code/blob/main/robots.txt"}}, {"name": "tester.html", "path": "tester.html", "sha": "bd5af2221ee8a89b7ab1025d109d1f62f79b3fb5", "size": 417, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/tester.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/tester.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/bd5af2221ee8a89b7ab1025d109d1f62f79b3fb5", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/tester.html?token=ABLKXDOWJBF2D6HUUYY6YJ3DIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/tester.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/bd5af2221ee8a89b7ab1025d109d1f62f79b3fb5", "html": "https://github.com/gina305/Switch-Code/blob/main/tester.html"}}, {"name": "testfolder", "path": "testfolder", "sha": "9d8c23fa7787d84211c76fdf0dd8a7adfed27939", "size": 0, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/testfolder?ref=main", "html_url": "https://github.com/gina305/Switch-Code/tree/main/testfolder", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/trees/9d8c23fa7787d84211c76fdf0dd8a7adfed27939", "download_url": null, "type": "dir", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/testfolder?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/trees/9d8c23fa7787d84211c76fdf0dd8a7adfed27939", "html": "https://github.com/gina305/Switch-Code/tree/main/testfolder"}}, {"name": "testing222.html", "path": "testing222.html", "sha": "6a598551d36146e7f3aef44d9158ad61cd741c94", "size": 7530, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/testing222.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/testing222.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/6a598551d36146e7f3aef44d9158ad61cd741c94", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/testing222.html?token=ABLKXDMCPYG5UZGEXTATTLDDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/testing222.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/6a598551d36146e7f3aef44d9158ad61cd741c94", "html": "https://github.com/gina305/Switch-Code/blob/main/testing222.html"}}, {"name": "tracy.html", "path": "tracy.html", "sha": "d5b95cb2a330dc8424a68c918bcfd0233d31f85e", "size": 18, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/tracy.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/tracy.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/d5b95cb2a330dc8424a68c918bcfd0233d31f85e", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/tracy.html?token=ABLKXDKU22FFQ6M27E5GNHTDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/tracy.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/d5b95cb2a330dc8424a68c918bcfd0233d31f85e", "html": "https://github.com/gina305/Switch-Code/blob/main/tracy.html"}}, {"name": "trax.html", "path": "trax.html", "sha": "3eae00b7aa2ec09cbad5b46e364dda57c75dc0df", "size": 27, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/trax.html?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/trax.html", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/3eae00b7aa2ec09cbad5b46e364dda57c75dc0df", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/trax.html?token=ABLKXDOGT6BFKKS4UMD4B4DDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/trax.html?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/3eae00b7aa2ec09cbad5b46e364dda57c75dc0df", "html": "https://github.com/gina305/Switch-Code/blob/main/trax.html"}}, {"name": "{{params.path}}", "path": "{{params.path}}", "sha": "d5b95cb2a330dc8424a68c918bcfd0233d31f85e", "size": 18, "url": "https://api.github.com/repos/gina305/Switch-Code/contents/%7B%7Bparams.path%7D%7D?ref=main", "html_url": "https://github.com/gina305/Switch-Code/blob/main/%7B%7Bparams.path%7D%7D", "git_url": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/d5b95cb2a330dc8424a68c918bcfd0233d31f85e", "download_url": "https://raw.githubusercontent.com/gina305/Switch-Code/main/%7B%7Bparams.path%7D%7D?token=ABLKXDJXE4AIHSFWJFORCSLDIBYGA", "type": "file", "_links": {"self": "https://api.github.com/repos/gina305/Switch-Code/contents/%7B%7Bparams.path%7D%7D?ref=main", "git": "https://api.github.com/repos/gina305/Switch-Code/git/blobs/d5b95cb2a330dc8424a68c918bcfd0233d31f85e", "html": "https://github.com/gina305/Switch-Code/blob/main/%7B%7Bparams.path%7D%7D"}}]
{"$schema": "http://json-schema.org/schema#", "type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "path": {"type": "string"}, "sha": {"type": "string"}, "size": {"type": "integer"}, "url": {"type": "string"}, "html_url": {"type": "string"}, "git_url": {"type": "string"}, "download_url": {"type": ["null", "string"]}, "type": {"type": "string"}, "_links": {"type": "object", "properties": {"self": {"type": "string"}, "git": {"type": "string"}, "html": {"type": "string"}}, "required": ["git", "html", "self"]}}, "required": ["_links", "download_url", "git_url", "html_url", "name", "path", "sha", "size", "type", "url"]}}
e7c04702-08be-4cb5-b83c-ad288be0182a/acdddd9a-7411-4c95-ba97-99031873566f/0/0
Real Estate USA
The API to search properties for sale or rent in USA
0.3
get property by id
get property by id
200
Response
{"meta": {"version": "1.1.251", "transformVersion": "2.0.20", "transformApi": "clientAPI", "data_key": "result", "api": "graphQL"}, "property": {"id": 1088950142, "rethink_id": 2928487827, "prop_status": "for_sale", "public_records": [{"baths": 2, "baths_1qtr": null, "baths_3qtr": null, "baths_full": 2, "baths_half": null, "beds": 3, "construction": "Wood Frame", "cooling": null, "cl_id": "06C8FB1AD9C555890991990B95AA6A0B", "date_updated": "04/09/2021", "distinct_baths": 2, "exterior1": null, "exterior2": null, "fireplace": null, "garage": null, "garage_spaces": null, "heating": null, "lot_size": 2996, "pool": null, "prop_type": "single_family", "roofing": null, "rooms": 5, "sqft": 0, "stories": 1, "style": null, "units": null, "view": null, "year_built": 1945, "year_renovated": null, "zoning": "RH1"}], "permalink": "1778-48th-Ave_San-Francisco_CA_94122_M10889-50142", "listings": [{"features": [{"category": "Bedrooms", "parent_category": "Interior", "text": ["Bedrooms: 3"]}, {"category": "Bathrooms", "parent_category": "Interior", "text": ["Total Bathrooms: 2.00", "Full Bathrooms: 2"]}, {"category": "Kitchen and Dining", "parent_category": "Interior", "text": ["Granite Counter"]}, {"category": "Appliances", "parent_category": "Interior", "text": ["Laundry Features: Dryer Included, Ground Floor, Inside Area, Washer Included"]}, {"category": "Land Info", "parent_category": "Exterior", "text": ["Lot Dimensions Source: SqFt", "Lot Size Acres: 0.0687787", "Lot Size Square Feet: 2996"]}, {"category": "Garage and Parking", "parent_category": "Exterior", "text": ["Driveway: Paved Driveway", "Other Parking: On Site (Single Family Only)", "Parking Features: Side-by-Side", "Parking Total: 1"]}, {"category": "Homeowners Association", "parent_category": "Community", "text": ["Association: No", "Calculated Total Monthly Association Fees: 0"]}, {"category": "Other Property Info", "parent_category": "Listing", "text": ["Source Listing Status: Pending", "County: San Francisco", "Cross Street: Noriega", "Source Property Type: Single Family Residence", "Area: SF District 2", "Source Neighborhood: SF District 2", "Parcel Number: 2002025", "Source System Name: C2C"]}, {"category": "Building and Construction", "parent_category": "Features", "text": ["Total Square Feet Living: 1546", "Year Built: 1945", "Property Age: 76", "Property Condition: Updated/Remodeled", "Levels or Stories: 2", "House Style: Mid-Century"]}, {"category": "Utilities", "parent_category": "Features", "text": ["Sewer: Public Sewer", "Water Source: Public"]}, {"category": "Legal and finance", "text": ["HOA Frequency: Monthly/0", "HOA fee: $0"]}], "office": {"name": "Compass", "advertiser_id": 3781697, "mls_set": "O-SFCA-COMP41", "href": "", "photo": {"href": null}, "email": "", "slogan": null, "address": {"city": "", "state_code": null}, "mls_memberships": {"member": {"office_system_id": "COMP41"}}, "phone1": {"number": "4158241100", "type": "office", "primary": true}}, "address": {"line": "1778 48th Ave", "street": "48th", "street_number": "1778", "city": "San Francisco", "state_code": "CA", "state": "California", "postal_code": "94122", "county": "San Francisco", "country": "USA", "street_suffix": "Ave", "lat": 37.753303, "long": -122.507245}, "agent": {"name": "Jessica Branson", "profile_name": "Jessica Branson", "advertiser_id": 810488, "href": "http://www.jessicabranson.com", "photo": {"href": "https://ap.rdcpix.com/749188186/6ee687399a5fdb8e53cc300eec0b5a82a-e0l.jpg"}, "nrds_id": null, "nrds_verified_id": null, "office_name": "Compass", "email": "[email protected]", "slogan": "Work with the best!", "mls_memberships": {"member": {"agent_system_id": "805610", "name": "Jessica Branson", "office_system_id": "COMP41", "id": "805610", "abbreviation": "SFCA"}}, "phone1": {"number": "4153417177", "type": "office", "primary": true}, "phone2": {"number": "4153417177", "type": "mobile", "primary": false}}, "price_history": [{"date": "2021-04-22", "price": 1295000}], "mls_id": "421529863", "mls": {"name": "SanFrancisco", "id": "421529863", "plan_id": null, "abbreviation": "SFCA", "type": "mls", "disclaimer": {"photo": null, "href": null, "text": "\u00a92021 San Francisco Association of REALTORS\u00ae. All rights reserved."}}, "broker": {"advertiser_id": 2107942, "name": "Compass", "phone1": {"number": "4158241100", "type": "broker"}}, "photos": [{"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m470522619x.jpg", "tags": [{"label": "exterior", "probability": 0.9602085947990417}, {"label": "exterior", "probability": 0.016569538041949272}, {"label": "exterior", "probability": 0.01598232053220272}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3672739062x.jpg", "tags": [{"label": "living_room", "probability": 0.9994646906852722}, {"label": "exterior", "probability": 0.0003751087060663849}, {"label": "dining_room", "probability": 0.00011152141087222844}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m983047985x.jpg", "tags": [{"label": "living_room", "probability": 0.9154430031776428}, {"label": "exterior", "probability": 0.03993780165910721}, {"label": "bedroom", "probability": 0.036541927605867386}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3659335394x.jpg", "tags": [{"label": "living_room", "probability": 0.9979246854782104}, {"label": "exterior", "probability": 0.0009790281765162945}, {"label": "dining_room", "probability": 0.0006274429033510387}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m815636665x.jpg", "tags": [{"label": "living_room", "probability": 0.9991274476051331}, {"label": "exterior", "probability": 0.0005336945760063827}, {"label": "dining_room", "probability": 0.000126074199215509}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m403525113x.jpg", "tags": [{"label": "living_room", "probability": 0.7969666719436646}, {"label": "dining_room", "probability": 0.12654459476470947}, {"label": "unknown", "probability": 0.052637334913015366}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m1884711310x.jpg", "tags": [{"label": "dining_room", "probability": 0.9979666471481323}, {"label": "unknown", "probability": 0.0009841313585639}, {"label": "unknown", "probability": 0.0009158925386145711}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3718294243x.jpg", "tags": [{"label": "kitchen", "probability": 0.8153510689735413}, {"label": "dining_room", "probability": 0.15646947920322418}, {"label": "living_room", "probability": 0.014420260675251484}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m56890958x.jpg", "tags": [{"label": "kitchen", "probability": 0.9746714234352112}, {"label": "unknown", "probability": 0.025070060044527054}, {"label": "exterior", "probability": 7.236789679154754e-05}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3147611045x.jpg", "tags": [{"label": "kitchen", "probability": 0.9999970197677612}, {"label": "unknown", "probability": 2.5055594505829504e-06}, {"label": "bathroom", "probability": 2.5354239596708794e-07}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m350108438x.jpg", "tags": [{"label": "kitchen", "probability": 0.9999351501464844}, {"label": "unknown", "probability": 5.2069844969082624e-05}, {"label": "dining_room", "probability": 2.978520342367119e-06}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m947701302x.jpg", "tags": [{"label": "kitchen", "probability": 0.98269122838974}, {"label": "dining_room", "probability": 0.00688207196071744}, {"label": "unknown", "probability": 0.005160940811038017}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m943840632x.jpg", "tags": [{"label": "bedroom", "probability": 0.9999945163726807}, {"label": "exterior", "probability": 2.627961748657981e-06}, {"label": "unknown", "probability": 1.2763571248797234e-06}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m2420097220x.jpg", "tags": [{"label": "bedroom", "probability": 0.9999849796295166}, {"label": "unknown", "probability": 5.385525582823902e-06}, {"label": "living_room", "probability": 3.641610874183243e-06}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m4157002973x.jpg", "tags": [{"label": "bedroom", "probability": 0.9999983310699463}, {"label": "unknown", "probability": 8.650013683109137e-07}, {"label": "unknown", "probability": 4.947937668475788e-07}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m2281130655x.jpg", "tags": [{"label": "bedroom", "probability": 0.9986863732337952}, {"label": "unknown", "probability": 0.000752028776332736}, {"label": "unknown", "probability": 0.00020693594706244767}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3907925165x.jpg", "tags": [{"label": "bedroom", "probability": 0.999920129776001}, {"label": "exterior", "probability": 3.6748708225786686e-05}, {"label": "unknown", "probability": 1.918940142786596e-05}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m1616223988x.jpg", "tags": [{"label": "bedroom", "probability": 0.9999963045120239}, {"label": "unknown", "probability": 1.8965627077704994e-06}, {"label": "unknown", "probability": 1.1251270279899472e-06}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m290629817x.jpg", "tags": [{"label": "bedroom", "probability": 0.9999740123748779}, {"label": "exterior", "probability": 6.941677384020295e-06}, {"label": "unknown", "probability": 6.4533710428804625e-06}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m2426718267x.jpg", "tags": [{"label": "unknown", "probability": 0.6284233927726746}, {"label": "bathroom", "probability": 0.1301097571849823}, {"label": "bedroom", "probability": 0.1284780204296112}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m2438613517x.jpg", "tags": [{"label": "bathroom", "probability": 0.9998601675033569}, {"label": "unknown", "probability": 0.0001280690630665049}, {"label": "unknown", "probability": 1.0443650353408884e-05}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3745232251x.jpg", "tags": [{"label": "bedroom", "probability": 0.9999822378158569}, {"label": "unknown", "probability": 1.0035499144578353e-05}, {"label": "unknown", "probability": 3.1849754122958984e-06}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m216721967x.jpg", "tags": [{"label": "bedroom", "probability": 0.9996711015701294}, {"label": "unknown", "probability": 0.00020433194003999233}, {"label": "kitchen", "probability": 6.28323687124066e-05}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m697493280x.jpg", "tags": [{"label": "bedroom", "probability": 0.9999889135360718}, {"label": "unknown", "probability": 4.613691089616623e-06}, {"label": "unknown", "probability": 3.5973118883703137e-06}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m564374866x.jpg", "tags": [{"label": "unknown", "probability": 0.5004279613494873}, {"label": "dining_room", "probability": 0.37420472502708435}, {"label": "living_room", "probability": 0.07070062309503555}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m2457110646x.jpg", "tags": [{"label": "bedroom", "probability": 0.8624307513237}, {"label": "unknown", "probability": 0.10430910438299179}, {"label": "unknown", "probability": 0.016847174614667892}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m4111865142x.jpg", "tags": [{"label": "bathroom", "probability": 0.876237154006958}, {"label": "unknown", "probability": 0.1134066954255104}, {"label": "bedroom", "probability": 0.008508848957717419}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m1523382631x.jpg", "tags": [{"label": "bathroom", "probability": 0.9999827146530151}, {"label": "bedroom", "probability": 9.167044481728226e-06}, {"label": "unknown", "probability": 5.354876975616207e-06}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m601330833x.jpg", "tags": [{"label": "bathroom", "probability": 0.9964350461959839}, {"label": "unknown", "probability": 0.003413483267650008}, {"label": "unknown", "probability": 0.0001428054238203913}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m2441045537x.jpg", "tags": [{"label": "unknown", "probability": 0.7144671082496643}, {"label": "unknown", "probability": 0.27866706252098083}, {"label": "bedroom", "probability": 0.0031403589528054}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m2551434473x.jpg", "tags": [{"label": "unknown", "probability": 0.446691632270813}, {"label": "bedroom", "probability": 0.20569582283496857}, {"label": "kitchen", "probability": 0.16187870502471924}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m915841992x.jpg", "tags": [{"label": "bathroom", "probability": 0.6737403273582458}, {"label": "unknown", "probability": 0.31551602482795715}, {"label": "unknown", "probability": 0.0065467883832752705}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3859162499x.jpg", "tags": [{"label": "bathroom", "probability": 0.873047947883606}, {"label": "unknown", "probability": 0.10116282105445862}, {"label": "unknown", "probability": 0.0242305938154459}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m2462246649x.jpg", "tags": [{"label": "bathroom", "probability": 0.7188741564750671}, {"label": "unknown", "probability": 0.19322936236858368}, {"label": "unknown", "probability": 0.07394784688949585}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m1587544916x.jpg", "tags": [{"label": "bathroom", "probability": 0.9515361785888672}, {"label": "unknown", "probability": 0.04528764262795448}, {"label": "bedroom", "probability": 0.0027343882247805595}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3664121027x.jpg", "tags": [{"label": "unknown", "probability": 0.9996597766876221}, {"label": "living_room", "probability": 0.00020832987502217293}, {"label": "exterior", "probability": 0.0001284585305256769}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m1579421755x.jpg", "tags": [{"label": "exterior", "probability": 0.9932988882064819}, {"label": "exterior", "probability": 0.006627766415476799}, {"label": "exterior", "probability": 3.226494663977064e-05}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m4268234780x.jpg", "tags": [{"label": "exterior", "probability": 0.6344853043556213}, {"label": "exterior", "probability": 0.3280353546142578}, {"label": "exterior", "probability": 0.014860011637210846}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m1511672651x.jpg", "tags": [{"label": "exterior", "probability": 0.9977498650550842}, {"label": "exterior", "probability": 0.0017118253745138645}, {"label": "exterior", "probability": 0.0003824328014161438}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m638204637x.jpg", "tags": [{"label": "exterior", "probability": 0.8914366364479065}, {"label": "exterior", "probability": 0.10575667768716812}, {"label": "exterior", "probability": 0.0008560247370041907}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m2247698839x.jpg", "tags": [{"label": "exterior", "probability": 0.8868019580841064}, {"label": "exterior", "probability": 0.05278494581580162}, {"label": "living_room", "probability": 0.027573250234127045}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3465518162x.jpg", "tags": [{"label": "exterior", "probability": 0.9185523986816406}, {"label": "exterior", "probability": 0.055710867047309875}, {"label": "living_room", "probability": 0.017975516617298126}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3086661925x.jpg", "tags": [{"label": "exterior", "probability": 0.8866312503814697}, {"label": "exterior", "probability": 0.06559241563081741}, {"label": "exterior", "probability": 0.018691305071115494}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3762021538x.jpg", "tags": [{"label": "exterior", "probability": 0.9640710949897766}, {"label": "exterior", "probability": 0.02498539723455906}, {"label": "exterior", "probability": 0.010336414910852909}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3239148056x.jpg", "tags": [{"label": "exterior", "probability": 0.8937368988990784}, {"label": "exterior", "probability": 0.09659624099731445}, {"label": "exterior", "probability": 0.006997148040682077}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m2055648814x.jpg", "tags": [{"label": "exterior", "probability": 0.3927290141582489}, {"label": "exterior", "probability": 0.3285207748413086}, {"label": "exterior", "probability": 0.20264947414398193}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3264129636x.jpg", "tags": [{"label": "exterior", "probability": 0.9099305868148804}, {"label": "exterior", "probability": 0.032037153840065}, {"label": "exterior", "probability": 0.030728591606020927}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m2731956780x.jpg", "tags": [{"label": "exterior", "probability": 0.8334575891494751}, {"label": "exterior", "probability": 0.12813377380371094}, {"label": "exterior", "probability": 0.02044171467423439}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m4112234386x.jpg", "tags": [{"label": "unknown", "probability": 0.5295521020889282}, {"label": "bathroom", "probability": 0.3828457295894623}, {"label": "bedroom", "probability": 0.07063823193311691}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m893347361x.jpg", "tags": [{"label": "unknown", "probability": 0.8965873122215271}, {"label": "unknown", "probability": 0.07831831276416779}, {"label": "bedroom", "probability": 0.0173083133995533}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3108595399x.jpg", "tags": [{"label": "exterior", "probability": 0.5261219143867493}, {"label": "exterior", "probability": 0.2116100788116455}, {"label": "exterior", "probability": 0.16543643176555634}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m1113421013x.jpg", "tags": [{"label": "exterior", "probability": 0.988558292388916}, {"label": "exterior", "probability": 0.010684633627533913}, {"label": "exterior", "probability": 0.0003530503308866173}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m395646287x.jpg", "tags": [{"label": "exterior", "probability": 0.9998797178268433}, {"label": "exterior", "probability": 0.00010927934636129066}, {"label": "exterior", "probability": 9.842985491559375e-06}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m4006131389x.jpg", "tags": [{"label": "unknown", "probability": 0.6643298268318176}, {"label": "unknown", "probability": 0.3352966606616974}, {"label": "unknown", "probability": 0.0003164702211506665}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m2707663900x.jpg", "tags": [{"label": "unknown", "probability": 0.5504231452941895}, {"label": "dining_room", "probability": 0.23159842193126678}, {"label": "exterior", "probability": 0.19465897977352142}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m60042423x.jpg", "tags": [{"label": "exterior", "probability": 0.9912322163581848}, {"label": "exterior", "probability": 0.008339380845427513}, {"label": "exterior", "probability": 0.00021944683976471424}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m54168089x.jpg", "tags": [{"label": "exterior", "probability": 0.9732939004898071}, {"label": "exterior", "probability": 0.026014048606157303}, {"label": "unknown", "probability": 0.000619676779024303}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m1337375792x.jpg", "tags": [{"label": "exterior", "probability": 0.7235809564590454}, {"label": "unknown", "probability": 0.20983068645000458}, {"label": "exterior", "probability": 0.044906292110681534}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m1038260247x.jpg", "tags": [{"label": "unknown", "probability": 0.8617817759513855}, {"label": "exterior", "probability": 0.135854572057724}, {"label": "exterior", "probability": 0.0010623149573802948}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3746531359x.jpg", "tags": [{"label": "exterior", "probability": 0.9671664834022522}, {"label": "exterior", "probability": 0.016395995393395424}, {"label": "exterior", "probability": 0.016121884807944298}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m2310113903x.jpg", "tags": [{"label": "exterior", "probability": 0.5758911967277527}, {"label": "unknown", "probability": 0.4238561987876892}, {"label": "exterior", "probability": 7.872279093135148e-05}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m1873480963x.jpg", "tags": [{"label": "exterior", "probability": 0.5710710883140564}, {"label": "unknown", "probability": 0.3349025249481201}, {"label": "exterior", "probability": 0.05774927884340286}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3350656997x.jpg", "tags": [{"label": "exterior", "probability": 0.9465942978858948}, {"label": "exterior", "probability": 0.021189585328102112}, {"label": "exterior", "probability": 0.011335626244544983}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m4114317711x.jpg", "tags": [{"label": "exterior", "probability": 0.514028787612915}, {"label": "exterior", "probability": 0.3863726556301117}, {"label": "exterior", "probability": 0.06328187882900238}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m927171281x.jpg", "tags": [{"label": "exterior", "probability": 0.9990097284317017}, {"label": "exterior", "probability": 0.0005901590338908136}, {"label": "unknown", "probability": 0.0002985440078191459}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3895779007x.jpg", "tags": [{"label": "unknown", "probability": 0.9735194444656372}, {"label": "exterior", "probability": 0.026401443406939507}, {"label": "exterior", "probability": 2.496725574019365e-05}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m985674045x.jpg", "tags": [{"label": "exterior", "probability": 0.6931542158126831}, {"label": "exterior", "probability": 0.14286589622497559}, {"label": "exterior", "probability": 0.1224326491355896}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m1124877906x.jpg", "tags": [{"label": "exterior", "probability": 0.6325152516365051}, {"label": "exterior", "probability": 0.365169882774353}, {"label": "exterior", "probability": 0.0008303296635858715}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3188934200x.jpg", "tags": [{"label": "exterior", "probability": 0.9937508702278137}, {"label": "unknown", "probability": 0.006238359492272139}, {"label": "exterior", "probability": 4.994165010430152e-06}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m4236441112x.jpg", "tags": [{"label": "unknown", "probability": 0.9504718780517578}, {"label": "exterior", "probability": 0.02801533229649067}, {"label": "exterior", "probability": 0.010315571911633015}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m4232355669x.jpg", "tags": [{"label": "unknown", "probability": 0.9894443154335022}, {"label": "exterior", "probability": 0.005391975864768028}, {"label": "exterior", "probability": 0.0018785782158374786}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m2046959670x.jpg", "tags": [{"label": "unknown", "probability": 0.9196850061416626}, {"label": "exterior", "probability": 0.07514631748199463}, {"label": "exterior", "probability": 0.0029247950296849012}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3077587600x.jpg", "tags": [{"label": "exterior", "probability": 0.9980208873748779}, {"label": "unknown", "probability": 0.001538950833491981}, {"label": "exterior", "probability": 0.00029196758987382054}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m345213868x.jpg", "tags": [{"label": "exterior", "probability": 0.5710917115211487}, {"label": "unknown", "probability": 0.42810705304145813}, {"label": "unknown", "probability": 0.0006630701827816665}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m347257201x.jpg", "tags": [{"label": "unknown", "probability": 0.9251017570495605}, {"label": "exterior", "probability": 0.06892483681440353}, {"label": "exterior", "probability": 0.0033077721018344164}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m832613694x.jpg", "tags": [{"label": "exterior", "probability": 0.980728268623352}, {"label": "exterior", "probability": 0.00840817205607891}, {"label": "exterior", "probability": 0.0036287154071033}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m1974379693x.jpg", "tags": [{"label": "unknown", "probability": 0.9706840515136719}, {"label": "exterior", "probability": 0.01135997287929058}, {"label": "unknown", "probability": 0.009143803268671036}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3992005573x.jpg", "tags": [{"label": "exterior", "probability": 0.9993575215339661}, {"label": "exterior", "probability": 0.0006383738946169615}, {"label": "exterior", "probability": 2.12307122637867e-06}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m69313080x.jpg", "tags": [{"label": "exterior", "probability": 0.4719943404197693}, {"label": "unknown", "probability": 0.15908467769622803}, {"label": "exterior", "probability": 0.15557008981704712}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m147673305x.jpg", "tags": [{"label": "exterior", "probability": 0.9980558156967163}, {"label": "exterior", "probability": 0.0014961729757487774}, {"label": "exterior", "probability": 0.00024833445786498487}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m2016302801x.jpg", "tags": [{"label": "exterior", "probability": 0.999997615814209}, {"label": "exterior", "probability": 2.25828785005433e-06}, {"label": "exterior", "probability": 5.760242771657431e-08}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m2888367864x.jpg", "tags": [{"label": "exterior", "probability": 0.4837300181388855}, {"label": "exterior", "probability": 0.2890820801258087}, {"label": "exterior", "probability": 0.13503490388393402}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m724867796x.jpg", "tags": [{"label": "exterior", "probability": 0.9999923706054688}, {"label": "exterior", "probability": 3.2115833619172918e-06}, {"label": "exterior", "probability": 2.3491427327826386e-06}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m676321605x.jpg", "tags": [{"label": "exterior", "probability": 0.5932658314704895}, {"label": "exterior", "probability": 0.18169473111629486}, {"label": "exterior", "probability": 0.16585186123847961}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m1557722139x.jpg", "tags": [{"label": "exterior", "probability": 0.9999971389770508}, {"label": "exterior", "probability": 1.3819093283018447e-06}, {"label": "exterior", "probability": 5.766838739873492e-07}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m3441818375x.jpg", "tags": [{"label": "exterior", "probability": 0.9994156360626221}, {"label": "exterior", "probability": 0.0004244136798661202}, {"label": "exterior", "probability": 7.874611765146255e-05}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m1607808156x.jpg", "tags": [{"label": "unknown", "probability": 0.7846331000328064}, {"label": "unknown", "probability": 0.21403247117996216}, {"label": "exterior", "probability": 0.0012678693747147918}], "type": "realtordotcom_mls_listing_image"}, {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m1509073647x.jpg", "tags": [{"label": "unknown", "probability": 0.5951789617538452}, {"label": "unknown", "probability": 0.3542915880680084}, {"label": "exterior", "probability": 0.046946313232183456}], "type": "realtordotcom_mls_listing_image"}], "photo_count": 88, "photo": {"description": "", "href": "http://ap.rdcpix.com/7747252695ec3df1727606a5ddda3cdel-m470522619x.jpg", "tags": [{"label": "exterior", "probability": 0.9602085947990417}, {"label": "exterior", "probability": 0.016569538041949272}, {"label": "exterior", "probability": 0.01598232053220272}], "type": "realtordotcom_mls_listing_image"}, "neighborhoods": [{"name": "Outer Sunset", "city": "San Francisco", "state_code": "CA", "level": "neighborhood", "id": "97764"}, {"name": "Southwest San Francisco", "city": "San Francisco", "state_code": "CA", "level": "macro_neighborhood", "id": "null"}], "style_raw": ["Mid-Century"], "style": null, "year_built": 1945, "description": "Steps to the amazing Great Hwy promenade and Ocean Beach for biking and surfing, and also delightfully walkable to world class shops, cafes and restaurants, this gorgeous 2 lvl mid century home has it all! The ~3000 ft lot also offers possible expansion potential. Large open, tiled foyer. Light filled living space w picture window and a fab mid century drum w/b fireplace. Sun drenched, open KIT and dining space with another blue sky picture window. Updated KIT with stainless appliances, and plenty of work and storage space. 2 spacious BDRs open to a huge deck that also leads down to the amazing backyard. A full tiled BA completes the main level. Downstairs: a sumptuous principal suite w a full tiled BA and a sunroom/office opens to the garden. Laundry/ craft room, huge garage with abundant storage. Freshly painted and warm wood flrs throughout. Steps to surfing, Andytown Coffee, Java Beach Cafe, Devils Teeth Baking Co, Gus's Market, the N-Judah. Bike to GG Pk. Mins to 280 fwy. WOW!", "lot_sqft": 2996, "baths_full": 2, "list_date": "2021-04-22T20:22:19Z", "sqft": 1546, "beds": 3, "baths": 2, "prop_type": "single_family", "prop_sub_type": null, "pending": true, "price": 1295000, "stories": 2, "advertisers": [{"builder": {"fulfillment_id": null}}], "products": ["core.agent", "core.broker", "co_broke", "co_broke"], "sold_history": [{"date": "2019-01-18T07:00:00Z", "source": "mls #477109", "listing": {"price": 1465000, "mls_id": "477109"}}, {"date": "2005-04-29T07:00:00Z", "source": "public record", "listing": {"price": 765500}}, {"date": "1999-11-19T07:00:00Z", "source": "public record", "listing": {"price": 390000}}, {"date": "1997-12-11T07:00:00Z", "source": "public record", "listing": {"price": 315000}}], "tax_history": [{"assessment": {"building": 448290, "land": 1046010, "total": 1494300}, "tax": 18649, "year": "2020"}, {"assessment": {"building": 382611, "land": 573921, "total": 956532}, "tax": 11926, "year": "2019"}, {"assessment": {"building": 375109, "land": 562668, "total": 937777}, "tax": 11523, "year": "2018"}, {"assessment": {"building": 367754, "land": 551636, "total": 919390}, "tax": 11088, "year": "2017"}, {"assessment": {"building": 360544, "land": 540820, "total": 901364}, "tax": 10898, "year": "2016"}, {"assessment": {"building": 355129, "land": 532697, "total": 887826}, "tax": 10762, "year": "2015"}, {"assessment": {"building": 314000, "land": 471000, "total": 785000}, "tax": 9474, "year": "2014"}, {"assessment": {"building": 252000, "land": 378000, "total": 630000}, "tax": 7734, "year": "2013"}, {"assessment": {"building": 159000, "land": 371000, "total": 530000}, "tax": 6362, "year": "2012"}, {"assessment": {"building": 276000, "land": 414000, "total": 690000}, "tax": 8188, "year": "2010"}, {"assessment": {"building": 216000, "land": 504000, "total": 720000}, "tax": 8500, "year": "2009"}, {"assessment": {"building": 324940, "land": 487410, "total": 812350}, "tax": 9596, "year": "2008"}], "id": 2928487827, "pending_date": "2021-04-27T16:25:01", "neighborhood": "Outer Sunset - San Francisco,CA", "permalink": "1778-48th-Ave_San-Francisco_CA_94122_M10889-50142", "raw_products": ["core.agent", "core.broker", "co_broke", "co_broke"], "lead_forms": [{"form_type": "classic", "lead_type": "co_broke", "show_contact_an_agent": true, "show_text_leads": true, "show_contact_a_lender": true, "is_lcm_enabled": false, "flip_the_market_enabled": false, "show_veterans_united": true, "cashback_enabled": false, "smarthome_enabled": false, "google_cashback_enabled": false}]}], "schools": [{"student_count": 1188, "rating": 8, "funding_type": "public", "greatschools_id": "0606372", "lat": 37.751056, "education_levels": ["middle"], "nces_code": "063441005580", "distance_in_miles": 0.6, "district": {"id": "06151438811", "name": "San Francisco Unified School District"}, "name": "Giannini (A.P.) Middle School", "parent_rating": 4, "id": "078662441", "lon": -122.4973}, {"student_count": 551, "rating": 9, "funding_type": "public", "greatschools_id": "0606385", "lat": 37.758104, "education_levels": ["elementary"], "nces_code": "063441005609", "distance_in_miles": 0.4, "district": {"id": "06151438811", "name": "San Francisco Unified School District"}, "name": "Key (Francis Scott) Elementary School", "parent_rating": 5, "id": "078662631", "lon": -122.502281}], "product_name": "essentials"}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"meta": {"type": "object", "properties": {"version": {"type": "string"}, "transformVersion": {"type": "string"}, "transformApi": {"type": "string"}, "data_key": {"type": "string"}, "api": {"type": "string"}}, "required": ["api", "data_key", "transformApi", "transformVersion", "version"]}, "property": {"type": "object", "properties": {"id": {"type": "integer"}, "rethink_id": {"type": "integer"}, "prop_status": {"type": "string"}, "public_records": {"type": "array", "items": {"type": "object", "properties": {"baths": {"type": "integer"}, "baths_1qtr": {"type": "null"}, "baths_3qtr": {"type": "null"}, "baths_full": {"type": "integer"}, "baths_half": {"type": "null"}, "beds": {"type": "integer"}, "construction": {"type": "string"}, "cooling": {"type": "null"}, "cl_id": {"type": "string"}, "date_updated": {"type": "string"}, "distinct_baths": {"type": "integer"}, "exterior1": {"type": "null"}, "exterior2": {"type": "null"}, "fireplace": {"type": "null"}, "garage": {"type": "null"}, "garage_spaces": {"type": "null"}, "heating": {"type": "null"}, "lot_size": {"type": "integer"}, "pool": {"type": "null"}, "prop_type": {"type": "string"}, "roofing": {"type": "null"}, "rooms": {"type": "integer"}, "sqft": {"type": "integer"}, "stories": {"type": "integer"}, "style": {"type": "null"}, "units": {"type": "null"}, "view": {"type": "null"}, "year_built": {"type": "integer"}, "year_renovated": {"type": "null"}, "zoning": {"type": "string"}}, "required": ["baths", "baths_1qtr", "baths_3qtr", "baths_full", "baths_half", "beds", "cl_id", "construction", "cooling", "date_updated", "distinct_baths", "exterior1", "exterior2", "fireplace", "garage", "garage_spaces", "heating", "lot_size", "pool", "prop_type", "roofing", "rooms", "sqft", "stories", "style", "units", "view", "year_built", "year_renovated", "zoning"]}}, "permalink": {"type": "string"}, "listings": {"type": "array", "items": {"type": "object", "properties": {"features": {"type": "array", "items": {"type": "object", "properties": {"category": {"type": "string"}, "parent_category": {"type": "string"}, "text": {"type": "array", "items": {"type": "string"}}}, "required": ["category", "text"]}}, "office": {"type": "object", "properties": {"name": {"type": "string"}, "advertiser_id": {"type": "integer"}, "mls_set": {"type": "string"}, "href": {"type": "string"}, "photo": {"type": "object", "properties": {"href": {"type": "null"}}, "required": ["href"]}, "email": {"type": "string"}, "slogan": {"type": "null"}, "address": {"type": "object", "properties": {"city": {"type": "string"}, "state_code": {"type": "null"}}, "required": ["city", "state_code"]}, "mls_memberships": {"type": "object", "properties": {"member": {"type": "object", "properties": {"office_system_id": {"type": "string"}}, "required": ["office_system_id"]}}, "required": ["member"]}, "phone1": {"type": "object", "properties": {"number": {"type": "string"}, "type": {"type": "string"}, "primary": {"type": "boolean"}}, "required": ["number", "primary", "type"]}}, "required": ["address", "advertiser_id", "email", "href", "mls_memberships", "mls_set", "name", "phone1", "photo", "slogan"]}, "address": {"type": "object", "properties": {"line": {"type": "string"}, "street": {"type": "string"}, "street_number": {"type": "string"}, "city": {"type": "string"}, "state_code": {"type": "string"}, "state": {"type": "string"}, "postal_code": {"type": "string"}, "county": {"type": "string"}, "country": {"type": "string"}, "street_suffix": {"type": "string"}, "lat": {"type": "number"}, "long": {"type": "number"}}, "required": ["city", "country", "county", "lat", "line", "long", "postal_code", "state", "state_code", "street", "street_number", "street_suffix"]}, "agent": {"type": "object", "properties": {"name": {"type": "string"}, "profile_name": {"type": "string"}, "advertiser_id": {"type": "integer"}, "href": {"type": "string"}, "photo": {"type": "object", "properties": {"href": {"type": "string"}}, "required": ["href"]}, "nrds_id": {"type": "null"}, "nrds_verified_id": {"type": "null"}, "office_name": {"type": "string"}, "email": {"type": "string"}, "slogan": {"type": "string"}, "mls_memberships": {"type": "object", "properties": {"member": {"type": "object", "properties": {"agent_system_id": {"type": "string"}, "name": {"type": "string"}, "office_system_id": {"type": "string"}, "id": {"type": "string"}, "abbreviation": {"type": "string"}}, "required": ["abbreviation", "agent_system_id", "id", "name", "office_system_id"]}}, "required": ["member"]}, "phone1": {"type": "object", "properties": {"number": {"type": "string"}, "type": {"type": "string"}, "primary": {"type": "boolean"}}, "required": ["number", "primary", "type"]}, "phone2": {"type": "object", "properties": {"number": {"type": "string"}, "type": {"type": "string"}, "primary": {"type": "boolean"}}, "required": ["number", "primary", "type"]}}, "required": ["advertiser_id", "email", "href", "mls_memberships", "name", "nrds_id", "nrds_verified_id", "office_name", "phone1", "phone2", "photo", "profile_name", "slogan"]}, "price_history": {"type": "array", "items": {"type": "object", "properties": {"date": {"type": "string"}, "price": {"type": "integer"}}, "required": ["date", "price"]}}, "mls_id": {"type": "string"}, "mls": {"type": "object", "properties": {"name": {"type": "string"}, "id": {"type": "string"}, "plan_id": {"type": "null"}, "abbreviation": {"type": "string"}, "type": {"type": "string"}, "disclaimer": {"type": "object", "properties": {"photo": {"type": "null"}, "href": {"type": "null"}, "text": {"type": "string"}}, "required": ["href", "photo", "text"]}}, "required": ["abbreviation", "disclaimer", "id", "name", "plan_id", "type"]}, "broker": {"type": "object", "properties": {"advertiser_id": {"type": "integer"}, "name": {"type": "string"}, "phone1": {"type": "object", "properties": {"number": {"type": "string"}, "type": {"type": "string"}}, "required": ["number", "type"]}}, "required": ["advertiser_id", "name", "phone1"]}, "photos": {"type": "array", "items": {"type": "object", "properties": {"description": {"type": "string"}, "href": {"type": "string"}, "tags": {"type": "array", "items": {"type": "object", "properties": {"label": {"type": "string"}, "probability": {"type": "number"}}, "required": ["label", "probability"]}}, "type": {"type": "string"}}, "required": ["description", "href", "tags", "type"]}}, "photo_count": {"type": "integer"}, "photo": {"type": "object", "properties": {"description": {"type": "string"}, "href": {"type": "string"}, "tags": {"type": "array", "items": {"type": "object", "properties": {"label": {"type": "string"}, "probability": {"type": "number"}}, "required": ["label", "probability"]}}, "type": {"type": "string"}}, "required": ["description", "href", "tags", "type"]}, "neighborhoods": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "city": {"type": "string"}, "state_code": {"type": "string"}, "level": {"type": "string"}, "id": {"type": "string"}}, "required": ["city", "id", "level", "name", "state_code"]}}, "style_raw": {"type": "array", "items": {"type": "string"}}, "style": {"type": "null"}, "year_built": {"type": "integer"}, "description": {"type": "string"}, "lot_sqft": {"type": "integer"}, "baths_full": {"type": "integer"}, "list_date": {"type": "string"}, "sqft": {"type": "integer"}, "beds": {"type": "integer"}, "baths": {"type": "integer"}, "prop_type": {"type": "string"}, "prop_sub_type": {"type": "null"}, "pending": {"type": "boolean"}, "price": {"type": "integer"}, "stories": {"type": "integer"}, "advertisers": {"type": "array", "items": {"type": "object", "properties": {"builder": {"type": "object", "properties": {"fulfillment_id": {"type": "null"}}, "required": ["fulfillment_id"]}}, "required": ["builder"]}}, "products": {"type": "array", "items": {"type": "string"}}, "sold_history": {"type": "array", "items": {"type": "object", "properties": {"date": {"type": "string"}, "source": {"type": "string"}, "listing": {"type": "object", "properties": {"price": {"type": "integer"}, "mls_id": {"type": "string"}}, "required": ["price"]}}, "required": ["date", "listing", "source"]}}, "tax_history": {"type": "array", "items": {"type": "object", "properties": {"assessment": {"type": "object", "properties": {"building": {"type": "integer"}, "land": {"type": "integer"}, "total": {"type": "integer"}}, "required": ["building", "land", "total"]}, "tax": {"type": "integer"}, "year": {"type": "string"}}, "required": ["assessment", "tax", "year"]}}, "id": {"type": "integer"}, "pending_date": {"type": "string"}, "neighborhood": {"type": "string"}, "permalink": {"type": "string"}, "raw_products": {"type": "array", "items": {"type": "string"}}, "lead_forms": {"type": "array", "items": {"type": "object", "properties": {"form_type": {"type": "string"}, "lead_type": {"type": "string"}, "show_contact_an_agent": {"type": "boolean"}, "show_text_leads": {"type": "boolean"}, "show_contact_a_lender": {"type": "boolean"}, "is_lcm_enabled": {"type": "boolean"}, "flip_the_market_enabled": {"type": "boolean"}, "show_veterans_united": {"type": "boolean"}, "cashback_enabled": {"type": "boolean"}, "smarthome_enabled": {"type": "boolean"}, "google_cashback_enabled": {"type": "boolean"}}, "required": ["cashback_enabled", "flip_the_market_enabled", "form_type", "google_cashback_enabled", "is_lcm_enabled", "lead_type", "show_contact_a_lender", "show_contact_an_agent", "show_text_leads", "show_veterans_united", "smarthome_enabled"]}}}, "required": ["address", "advertisers", "agent", "baths", "baths_full", "beds", "broker", "description", "features", "id", "lead_forms", "list_date", "lot_sqft", "mls", "mls_id", "neighborhood", "neighborhoods", "office", "pending", "pending_date", "permalink", "photo", "photo_count", "photos", "price", "price_history", "products", "prop_sub_type", "prop_type", "raw_products", "sold_history", "sqft", "stories", "style", "style_raw", "tax_history", "year_built"]}}, "schools": {"type": "array", "items": {"type": "object", "properties": {"student_count": {"type": "integer"}, "rating": {"type": "integer"}, "funding_type": {"type": "string"}, "greatschools_id": {"type": "string"}, "lat": {"type": "number"}, "education_levels": {"type": "array", "items": {"type": "string"}}, "nces_code": {"type": "string"}, "distance_in_miles": {"type": "number"}, "district": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "required": ["id", "name"]}, "name": {"type": "string"}, "parent_rating": {"type": "integer"}, "id": {"type": "string"}, "lon": {"type": "number"}}, "required": ["distance_in_miles", "district", "education_levels", "funding_type", "greatschools_id", "id", "lat", "lon", "name", "nces_code", "parent_rating", "rating", "student_count"]}}, "product_name": {"type": "string"}}, "required": ["id", "listings", "permalink", "product_name", "prop_status", "public_records", "rethink_id", "schools"]}}, "required": ["meta", "property"]}
e7c04702-08be-4cb5-b83c-ad288be0182a/61ff2de0-9411-41d2-825c-08f27f3e7095/0/0
Real Estate USA
The API to search properties for sale or rent in USA
0.3
locate schools
locate schools
200
Response
{"meta": {"build": "3.23.151"}, "schools": [{"nces_id": "062523003773", "id": "078590231", "greatschools_id": "0601317", "name": "Robert P. Ulrich Elementary School", "education_levels": ["elementary"], "funding_type": "public", "lat": 35.122802, "lon": -117.967056, "student_count": 527, "student_teacher_ratio": 22.4, "location": {"city_slug_id": "California-City_CA", "postal_code": "93505", "state": "CA", "county": "Kern", "city": "California City", "street": "9124 Catalpa Avenue"}, "phone": "(760) 373-4824", "distance_in_miles": 1.8, "grades": {"range": {"low": "K", "high": "2"}}, "relevance": "assigned", "ratings": {"great_schools_rating": null, "parent_rating": 3}, "district": {"id": "06151431811", "name": "Mojave Unified"}, "boundary_trimmed": {"type": "MultiPolygon", "coordinates": [[[[-117.7147724, 35.2729929], [-117.687458, 35.273428], [-117.67622, 35.273388], [-117.631362, 35.274171], [-117.631166, 35.249966], [-117.6309723, 35.2473571], [-117.630863, 35.22286], [-117.631208, 35.202464], [-117.631292, 35.182412], [-117.631194, 35.123693], [-117.630882, 35.09781], [-117.6309295, 35.097603], [-117.63329, 35.097558], [-117.633054, 35.086883], [-117.659743, 35.087035], [-117.668975, 35.087234], [-117.757229, 35.087476], [-117.757174, 35.094975], [-117.756976, 35.097389], [-117.75508, 35.097393], [-117.7549895, 35.111799], [-117.755575, 35.11197], [-117.759763, 35.112121], [-117.762772, 35.111915], [-117.770758, 35.111926], [-117.772726, 35.111787], [-117.775264, 35.111927], [-117.797319, 35.111719], [-117.80756, 35.111676], [-117.8079213, 35.111783], [-117.807961, 35.09726], [-117.810551, 35.097284], [-117.810664, 35.087638], [-117.835287, 35.08767], [-117.878284, 35.087348], [-117.899594, 35.08741], [-117.899393, 35.079359], [-117.899514, 35.072614], [-117.8991075, 35.0432255], [-117.899338, 35.037693], [-117.899192, 35.035421], [-117.899402, 35.03388], [-117.899402, 35.028732], [-117.8990235, 35.0140975], [-117.898993, 35.013968], [-117.89867, 35.013944], [-117.898766, 35.007249], [-117.899088, 35.002887], [-117.899134, 34.999373], [-117.907126, 34.999199], [-117.921335, 34.999494], [-117.932356, 34.999976], [-117.939814, 34.999093], [-117.951801, 34.99895], [-117.978845, 34.999513], [-117.98894, 34.999968], [-118.018021, 34.999252], [-118.024673, 34.998885], [-118.024696, 34.990594], [-118.024566, 34.988387], [-118.024917, 34.986967], [-118.024825, 34.9829], [-118.025635, 34.971376], [-118.025619, 34.970914], [-118.023889, 34.9684945], [-118.024656, 34.958508], [-118.024651, 34.954537], [-118.0548091, 34.9539357], [-118.0544639, 34.9551035], [-118.0462241, 35.4466086], [-118.0460531, 35.4480029], [-117.960702, 35.448115], [-117.950679, 35.447946], [-117.950484, 35.4266435], [-117.9506635, 35.425574], [-117.950337, 35.424438], [-117.950454, 35.389421], [-117.933393, 35.389408], [-117.933396, 35.389544], [-117.918693, 35.38977], [-117.843205, 35.38995], [-117.843506, 35.361864], [-117.8434215, 35.346066], [-117.843586, 35.343878], [-117.843614, 35.331382], [-117.8444155, 35.2901855], [-117.8433009, 35.283823], [-117.844366, 35.272183], [-117.8093, 35.272601], [-117.774142, 35.272549], [-117.7147724, 35.2729929]]]]}}, {"nces_id": "062523002042", "id": "078590141", "greatschools_id": "0601311", "name": "California City Middle School", "education_levels": ["middle"], "funding_type": "public", "lat": 35.110932, "lon": -117.954567, "student_count": 493, "student_teacher_ratio": 18.5, "location": {"city_slug_id": "California-City_CA", "postal_code": "93505", "state": "CA", "county": "Kern", "city": "California City", "street": "9736 Redwood Boulevard"}, "phone": "(760) 373-3241", "distance_in_miles": 1.6, "grades": {"range": {"low": "6", "high": "8"}}, "relevance": "assigned", "ratings": {"great_schools_rating": 3, "parent_rating": 2}, "district": {"id": "06151431811", "name": "Mojave Unified"}, "boundary_trimmed": {"type": "MultiPolygon", "coordinates": [[[[-117.7147724, 35.2729929], [-117.687458, 35.273428], [-117.67622, 35.273388], [-117.631362, 35.274171], [-117.631166, 35.249966], [-117.6309723, 35.2473571], [-117.630863, 35.22286], [-117.631208, 35.202464], [-117.631292, 35.182412], [-117.631194, 35.123693], [-117.630882, 35.09781], [-117.6309295, 35.097603], [-117.63329, 35.097558], [-117.633054, 35.086883], [-117.659743, 35.087035], [-117.668975, 35.087234], [-117.757229, 35.087476], [-117.757174, 35.094975], [-117.756976, 35.097389], [-117.75508, 35.097393], [-117.7549895, 35.111799], [-117.755575, 35.11197], [-117.759763, 35.112121], [-117.762772, 35.111915], [-117.770758, 35.111926], [-117.772726, 35.111787], [-117.775264, 35.111927], [-117.797319, 35.111719], [-117.80756, 35.111676], [-117.8079213, 35.111783], [-117.807961, 35.09726], [-117.810551, 35.097284], [-117.810664, 35.087638], [-117.835287, 35.08767], [-117.878284, 35.087348], [-117.899594, 35.08741], [-117.899393, 35.079359], [-117.899514, 35.072614], [-117.8991075, 35.0432255], [-117.899338, 35.037693], [-117.899192, 35.035421], [-117.899402, 35.03388], [-117.899402, 35.028732], [-117.8990235, 35.0140975], [-117.898993, 35.013968], [-117.89867, 35.013944], [-117.898766, 35.007249], [-117.899088, 35.002887], [-117.899134, 34.999373], [-117.907126, 34.999199], [-117.921335, 34.999494], [-117.932356, 34.999976], [-117.939814, 34.999093], [-117.951801, 34.99895], [-117.978845, 34.999513], [-117.98894, 34.999968], [-118.018021, 34.999252], [-118.024673, 34.998885], [-118.024696, 34.990594], [-118.024566, 34.988387], [-118.024917, 34.986967], [-118.024825, 34.9829], [-118.025635, 34.971376], [-118.025619, 34.970914], [-118.023889, 34.9684945], [-118.024656, 34.958508], [-118.024651, 34.954537], [-118.0548091, 34.9539357], [-118.0544639, 34.9551035], [-118.0462241, 35.4466086], [-118.0460531, 35.4480029], [-117.960702, 35.448115], [-117.950679, 35.447946], [-117.950484, 35.4266435], [-117.9506635, 35.425574], [-117.950337, 35.424438], [-117.950454, 35.389421], [-117.933393, 35.389408], [-117.933396, 35.389544], [-117.918693, 35.38977], [-117.843205, 35.38995], [-117.843506, 35.361864], [-117.8434215, 35.346066], [-117.843586, 35.343878], [-117.843614, 35.331382], [-117.8444155, 35.2901855], [-117.8433009, 35.283823], [-117.844366, 35.272183], [-117.8093, 35.272601], [-117.774142, 35.272549], [-117.7147724, 35.2729929]]]]}}, {"nces_id": "062523012107", "id": "078824321", "greatschools_id": "0617703", "name": "California City High School", "education_levels": ["high"], "funding_type": "public", "lat": 35.137827, "lon": -117.975644, "student_count": 520, "student_teacher_ratio": 21.6, "location": {"city_slug_id": "California-City_CA", "postal_code": "93505", "state": "CA", "county": "Kern", "city": "California City", "street": "8567 Raven Way"}, "phone": "(760) 373-5263", "distance_in_miles": 2.3, "grades": {"range": {"low": "9", "high": "12"}}, "relevance": "assigned", "ratings": {"great_schools_rating": 4, "parent_rating": 5}, "district": {"id": "06151431811", "name": "Mojave Unified"}, "boundary_trimmed": {"type": "MultiPolygon", "coordinates": [[[[-117.7147724, 35.2729929], [-117.687458, 35.273428], [-117.67622, 35.273388], [-117.631362, 35.274171], [-117.631166, 35.249966], [-117.6309723, 35.2473571], [-117.630863, 35.22286], [-117.631208, 35.202464], [-117.631292, 35.182412], [-117.631194, 35.123693], [-117.630882, 35.09781], [-117.6309295, 35.097603], [-117.63329, 35.097558], [-117.633054, 35.086883], [-117.659743, 35.087035], [-117.668975, 35.087234], [-117.757229, 35.087476], [-117.757174, 35.094975], [-117.756976, 35.097389], [-117.75508, 35.097393], [-117.7549895, 35.111799], [-117.755575, 35.11197], [-117.759763, 35.112121], [-117.762772, 35.111915], [-117.770758, 35.111926], [-117.772726, 35.111787], [-117.775264, 35.111927], [-117.797319, 35.111719], [-117.80756, 35.111676], [-117.8079213, 35.111783], [-117.807961, 35.09726], [-117.810551, 35.097284], [-117.810664, 35.087638], [-117.835287, 35.08767], [-117.878284, 35.087348], [-117.899594, 35.08741], [-117.899393, 35.079359], [-117.899514, 35.072614], [-117.8991075, 35.0432255], [-117.899338, 35.037693], [-117.899192, 35.035421], [-117.899402, 35.03388], [-117.899402, 35.028732], [-117.8990235, 35.0140975], [-117.898993, 35.013968], [-117.89867, 35.013944], [-117.898766, 35.007249], [-117.899088, 35.002887], [-117.899134, 34.999373], [-117.907126, 34.999199], [-117.921335, 34.999494], [-117.932356, 34.999976], [-117.939814, 34.999093], [-117.951801, 34.99895], [-117.978845, 34.999513], [-117.98894, 34.999968], [-118.018021, 34.999252], [-118.024673, 34.998885], [-118.024696, 34.990594], [-118.024566, 34.988387], [-118.024917, 34.986967], [-118.024825, 34.9829], [-118.025635, 34.971376], [-118.025619, 34.970914], [-118.023889, 34.9684945], [-118.024656, 34.958508], [-118.024651, 34.954537], [-118.0548091, 34.9539357], [-118.0544639, 34.9551035], [-118.0462241, 35.4466086], [-118.0460531, 35.4480029], [-117.960702, 35.448115], [-117.950679, 35.447946], [-117.950484, 35.4266435], [-117.9506635, 35.425574], [-117.950337, 35.424438], [-117.950454, 35.389421], [-117.933393, 35.389408], [-117.933396, 35.389544], [-117.918693, 35.38977], [-117.843205, 35.38995], [-117.843506, 35.361864], [-117.8434215, 35.346066], [-117.843586, 35.343878], [-117.843614, 35.331382], [-117.8444155, 35.2901855], [-117.8433009, 35.283823], [-117.844366, 35.272183], [-117.8093, 35.272601], [-117.774142, 35.272549], [-117.7147724, 35.2729929]]]]}}, {"nces_id": "062523011964", "id": "078821601", "greatschools_id": "0617512", "name": "Hacienda Elementary School", "education_levels": ["elementary"], "funding_type": "public", "lat": 35.110323, "lon": -117.959072, "student_count": 516, "student_teacher_ratio": 22.9, "location": {"city_slug_id": "California-City_CA", "postal_code": "93505", "state": "CA", "county": "Kern", "city": "California City", "street": "19950 Hacienda Boulevard"}, "phone": "(760) 373-5731", "distance_in_miles": 1.8, "grades": {"range": {"low": "3", "high": "5"}}, "relevance": "nearby", "ratings": {"great_schools_rating": 3, "parent_rating": 3}, "district": {"id": "06151431811", "name": "Mojave Unified"}}, {"nces_id": "6cb59e2777042a24c9f8c9b8aa9ae245", "id": "078941631", "greatschools_id": "0625915", "name": "Tumbleweed Academy", "education_levels": ["elementary", "middle", "high"], "funding_type": "private", "lat": 35.125988, "lon": -117.959717, "location": {"city_slug_id": "California-City_CA", "postal_code": "93505", "state": "CA", "county": "Kern", "city": "California City", "street": "9507 California City Boulevard"}, "phone": "(858) 361-5971", "distance_in_miles": 1.3, "grades": {"range": {"low": "1", "high": "12"}}, "relevance": "nearby", "ratings": {"great_schools_rating": null, "parent_rating": null}, "district": {"id": "06151428551"}}, {"nces_id": "A0101369", "id": "078787551", "greatschools_id": "0615130", "name": "Western Education Center", "education_levels": ["elementary", "middle", "high"], "funding_type": "private", "lat": 35.125526, "lon": -117.965197, "student_count": 10, "location": {"city_slug_id": "California-City_CA", "postal_code": "93505", "state": "CA", "county": "Kern", "city": "California City", "street": "9100 California City Boulevard"}, "phone": "(760) 373-9112", "distance_in_miles": 1.6, "grades": {"range": {"low": "5", "high": "12"}}, "relevance": "nearby", "ratings": {"great_schools_rating": null, "parent_rating": null}, "district": {"id": "06151428551"}}], "districts": []}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"meta": {"type": "object", "properties": {"build": {"type": "string"}}, "required": ["build"]}, "schools": {"type": "array", "items": {"type": "object", "properties": {"nces_id": {"type": "string"}, "id": {"type": "string"}, "greatschools_id": {"type": "string"}, "name": {"type": "string"}, "education_levels": {"type": "array", "items": {"type": "string"}}, "funding_type": {"type": "string"}, "lat": {"type": "number"}, "lon": {"type": "number"}, "student_count": {"type": "integer"}, "student_teacher_ratio": {"type": "number"}, "location": {"type": "object", "properties": {"city_slug_id": {"type": "string"}, "postal_code": {"type": "string"}, "state": {"type": "string"}, "county": {"type": "string"}, "city": {"type": "string"}, "street": {"type": "string"}}, "required": ["city", "city_slug_id", "county", "postal_code", "state", "street"]}, "phone": {"type": "string"}, "distance_in_miles": {"type": "number"}, "grades": {"type": "object", "properties": {"range": {"type": "object", "properties": {"low": {"type": "string"}, "high": {"type": "string"}}, "required": ["high", "low"]}}, "required": ["range"]}, "relevance": {"type": "string"}, "ratings": {"type": "object", "properties": {"great_schools_rating": {"type": ["integer", "null"]}, "parent_rating": {"type": ["integer", "null"]}}, "required": ["great_schools_rating", "parent_rating"]}, "district": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "required": ["id"]}, "boundary_trimmed": {"type": "object", "properties": {"type": {"type": "string"}, "coordinates": {"type": "array", "items": {"type": "array", "items": {"type": "array", "items": {"type": "array", "items": {"type": "number"}}}}}}, "required": ["coordinates", "type"]}}, "required": ["distance_in_miles", "district", "education_levels", "funding_type", "grades", "greatschools_id", "id", "lat", "location", "lon", "name", "nces_id", "phone", "ratings", "relevance"]}}, "districts": {"type": "array"}}, "required": ["districts", "meta", "schools"]}
e7c04702-08be-4cb5-b83c-ad288be0182a/6c6b2651-ca66-4868-86e4-ed54789e2994/0/0
Real Estate USA
The API to search properties for sale or rent in USA
0.3
list finance rates
list finance rates
200
Response
{"meta": {"build": "3.23.151"}, "rates": {"property_tax": 1.25, "insurance_rate": 0.3, "average_rate_30_year": "3.123", "average_rate_30_year_fha": "3.065", "average_rate_30_year_va": "2.997", "average_rate_20_year": "2.91", "average_rate_15_year": "2.491", "average_rate_10_year": "2.379", "average_rate_51_arm": "2.789", "average_rate_71_arm": "2.897", "meta": {"warnings": ""}}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"meta": {"type": "object", "properties": {"build": {"type": "string"}}, "required": ["build"]}, "rates": {"type": "object", "properties": {"property_tax": {"type": "number"}, "insurance_rate": {"type": "number"}, "average_rate_30_year": {"type": "string"}, "average_rate_30_year_fha": {"type": "string"}, "average_rate_30_year_va": {"type": "string"}, "average_rate_20_year": {"type": "string"}, "average_rate_15_year": {"type": "string"}, "average_rate_10_year": {"type": "string"}, "average_rate_51_arm": {"type": "string"}, "average_rate_71_arm": {"type": "string"}, "meta": {"type": "object", "properties": {"warnings": {"type": "string"}}, "required": ["warnings"]}}, "required": ["average_rate_10_year", "average_rate_15_year", "average_rate_20_year", "average_rate_30_year", "average_rate_30_year_fha", "average_rate_30_year_va", "average_rate_51_arm", "average_rate_71_arm", "insurance_rate", "meta", "property_tax"]}}, "required": ["meta", "rates"]}
e7c04702-08be-4cb5-b83c-ad288be0182a/50587fa8-a551-4472-9c26-53bb05cc2b43/0/0
Real Estate USA
The API to search properties for sale or rent in USA
0.3
calculate mortgage
calculate mortgage
200
Response
{"meta": {"build": "3.23.151"}, "mortgage": {"loan_amount": 1000000, "rate": 3.123, "term": 30, "monthly_payment": 6398, "principal_and_interest": 4283, "monthly_property_taxes": 1302, "monthly_home_insurance": 313, "hoa_fees": 500, "monthly_mortgage_insurance": 0, "total_payment": 1541760, "down_payment": 250000}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"meta": {"type": "object", "properties": {"build": {"type": "string"}}, "required": ["build"]}, "mortgage": {"type": "object", "properties": {"loan_amount": {"type": "integer"}, "rate": {"type": "number"}, "term": {"type": "integer"}, "monthly_payment": {"type": "integer"}, "principal_and_interest": {"type": "integer"}, "monthly_property_taxes": {"type": "integer"}, "monthly_home_insurance": {"type": "integer"}, "hoa_fees": {"type": "integer"}, "monthly_mortgage_insurance": {"type": "integer"}, "total_payment": {"type": "integer"}, "down_payment": {"type": "integer"}}, "required": ["down_payment", "hoa_fees", "loan_amount", "monthly_home_insurance", "monthly_mortgage_insurance", "monthly_payment", "monthly_property_taxes", "principal_and_interest", "rate", "term", "total_payment"]}}, "required": ["meta", "mortgage"]}
d0839629-3d3c-4159-9565-d535c5f6de47/46c11b88-a16d-42b2-9490-746b808b0923/0/0
ZZZapio Utilities
Powerful endpoints for data management, formatting and validation.
null
Sortz - Data Sorting
Using the /sortz endpoint will help when the data needs sorting. After you've cleaned your data it may be time to sort it alphabetically or in reverse. Currently available scrubbing options are: alphabetize, alphabetizereverse This is a small set of options, but can be built out upon request. Object and Array sorting will be added as demand requires.
200
Default JSON Object
{"hitCount": 1, "isCache": false, "life": 0, "messages": {}, "originTs": 1638498312, "requestHash": "260e1d59100d3e01503ed31896c5aba2", "response": "alpha,maxlen:6,required,uppercase", "success": true, "timers": {"totality": 0.1159}, "ts": 1638557445, "version": "1.0"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"hitCount": {"type": "integer"}, "isCache": {"type": "boolean"}, "life": {"type": "integer"}, "messages": {"type": "object"}, "originTs": {"type": "integer"}, "requestHash": {"type": "string"}, "response": {"type": "string"}, "success": {"type": "boolean"}, "timers": {"type": "object", "properties": {"totality": {"type": "number"}}, "required": ["totality"]}, "ts": {"type": "integer"}, "version": {"type": "string"}}, "required": ["hitCount", "isCache", "life", "messages", "originTs", "requestHash", "response", "success", "timers", "ts", "version"]}
d0839629-3d3c-4159-9565-d535c5f6de47/37e99ab7-9794-4a62-8692-2639df372932/0/0
ZZZapio Utilities
Powerful endpoints for data management, formatting and validation.
null
Formatz - Data Formatting
Using the /formatz endpoint will help when the data is not formatted correctly. This is also where data can pass through encrypt/decrypt for secure data. Currently available formatting options are: uppercase, lowercase, encrypt, decrypt, encrypthash, hash, base64on, base64off, number, trim
200
Default JSON Object
{"hitCount": 1, "isCache": false, "life": 0, "messages": {}, "originTs": 1638498312, "requestHash": "899ec96dce998d76321bb73660a94732", "response": "ZZZAP.IO", "success": true, "timers": {"totality": 0.1044}, "ts": 1638504602, "version": "1.0"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"hitCount": {"type": "integer"}, "isCache": {"type": "boolean"}, "life": {"type": "integer"}, "messages": {"type": "object"}, "originTs": {"type": "integer"}, "requestHash": {"type": "string"}, "response": {"type": "string"}, "success": {"type": "boolean"}, "timers": {"type": "object", "properties": {"totality": {"type": "number"}}, "required": ["totality"]}, "ts": {"type": "integer"}, "version": {"type": "string"}}, "required": ["hitCount", "isCache", "life", "messages", "originTs", "requestHash", "response", "success", "timers", "ts", "version"]}
39c6faae-9351-41ab-bbbd-d0f0886fa333/ed518ebb-08bb-455c-bd2e-da2e470e9d83/0/0
login
login api
0.2
letmein
letmein
123
New Example
{"username": "value1", "password": "value2", "token": "thisisajwttoken"}
{"type": "object", "properties": {"username": {"type": "string"}, "password": {"type": "string"}, "token": {"type": "string"}}}
7248bf10-d36e-4a72-8210-f17872f0275a/e2b49d3d-a37e-4cd4-9ad9-93f359afc4cc/1/0
OCI SLO
SLO metrics for OCI IaaS/PaaS
null
list
Get List of IaaS/PaaS OCI Services
200
New Example
{"key1": "value", "key2": "value"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
fa28705d-1d3d-4cf9-904b-9bb39e144281/8c5b7f45-7a30-4cd4-aeee-c76a08aef07a/0/0
BNPL Management
BNPL Management
null
Get BNPL Rules
Get BNPL Rules
404
New Example
{"trace_id": "", "code": "404.100", "message": "No Rules for selected Customers. Proceed with Default Prioritization"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"trace_id": {"type": "string"}, "code": {"type": "string"}, "message": {"type": "string"}}, "required": ["code", "message", "trace_id"]}
fa28705d-1d3d-4cf9-904b-9bb39e144281/8c5b7f45-7a30-4cd4-aeee-c76a08aef07a/1/0
BNPL Management
BNPL Management
null
Get BNPL Rules
Get BNPL Rules
409
New Example
{"trace_id": "", "code": "409.100", "message": "Selected customer cannot be granted the BNPL"}
{"type": "object", "properties": {"trace_id": {"type": "string"}, "code": {"type": "string"}, "message": {"type": "string"}}}
fa28705d-1d3d-4cf9-904b-9bb39e144281/8c5b7f45-7a30-4cd4-aeee-c76a08aef07a/2/0
BNPL Management
BNPL Management
null
Get BNPL Rules
Get BNPL Rules
200
New Example
{"sorted_rules": [{"alias": "bnpl", "limit_type": "relative", "limit_relation": "receipt_amount/amount_free_of_cash/amount_free_of_bonuses", "max_limit": 0.7, "min_limit": 0.1, "priority": 1}, {"alias": "bonuses", "limit_type": "absolute", "limit_relation": "receipt_amount/amount_free_of_cash/amount_free_of_bonuses", "max_limit": 19, "min_limit": 1, "priority": 2}], "trace_id": "sdfsdfsdfds-fsdfsdfsdf-sdfsdfsd-sdfsfsd"}
{"type": "object", "properties": {"sorted_rules": {"type": "array", "items": {"type": "object", "properties": {"alias": {"type": "string"}, "limit_type": {"type": "string"}, "limit_relation": {"type": "string"}, "max_limit": {"type": "number"}, "min_limit": {"type": "number"}, "priority": {"type": "integer"}}}}, "trace_id": {"type": "string"}}}
fa28705d-1d3d-4cf9-904b-9bb39e144281/be4f7865-611e-461d-8177-472eb719b8f3/0/0
BNPL Management
BNPL Management
null
Check if BNPL Transaction Pre-authorized
Check if BNPL Transaction Pre-authorized
404
Pre-authorization not found
{"trace_id": "<uuid>", "data": {"status": 0}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"trace_id": {"type": "string"}, "data": {"type": "object", "properties": {"status": {"type": "integer"}}, "required": ["status"]}}, "required": ["data", "trace_id"]}
fa28705d-1d3d-4cf9-904b-9bb39e144281/be4f7865-611e-461d-8177-472eb719b8f3/1/0
BNPL Management
BNPL Management
null
Check if BNPL Transaction Pre-authorized
Check if BNPL Transaction Pre-authorized
200
Success while authorize
{"trace_id": "<uuid>", "data": {"transaction_ext_id": "<uuid>", "status": 2}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"trace_id": {"type": "string"}, "data": {"type": "object", "properties": {"transaction_ext_id": {"type": "string"}, "status": {"type": "integer"}}, "required": ["status", "transaction_ext_id"]}}, "required": ["data", "trace_id"]}
fa28705d-1d3d-4cf9-904b-9bb39e144281/82d605af-b956-409c-b983-daea6f59d2f7/0/0
BNPL Management
BNPL Management
null
Authorize BNPL Transaction
Authorize BNPL Transaction
404
Pre-authorization not found
{"trace_id": "<uuid>", "data": {"status": 0}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"trace_id": {"type": "string"}, "data": {"type": "object", "properties": {"status": {"type": "integer"}}, "required": ["status"]}}, "required": ["data", "trace_id"]}
fa28705d-1d3d-4cf9-904b-9bb39e144281/82d605af-b956-409c-b983-daea6f59d2f7/1/0
BNPL Management
BNPL Management
null
Authorize BNPL Transaction
Authorize BNPL Transaction
200
Success while authorize
{"trace_id": "<uuid>", "data": {"transaction_ext_id": "<uuid>", "status": 2}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"trace_id": {"type": "string"}, "data": {"type": "object", "properties": {"transaction_ext_id": {"type": "string"}, "status": {"type": "integer"}}, "required": ["status", "transaction_ext_id"]}}, "required": ["data", "trace_id"]}
fa28705d-1d3d-4cf9-904b-9bb39e144281/82d605af-b956-409c-b983-daea6f59d2f7/2/0
BNPL Management
BNPL Management
null
Authorize BNPL Transaction
Authorize BNPL Transaction
403
Not Allowed
{"trace_id": "<uuid>", "data": {"status": 0}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"trace_id": {"type": "string"}, "data": {"type": "object", "properties": {"status": {"type": "integer"}}, "required": ["status"]}}, "required": ["data", "trace_id"]}
fa28705d-1d3d-4cf9-904b-9bb39e144281/82d605af-b956-409c-b983-daea6f59d2f7/3/0
BNPL Management
BNPL Management
null
Authorize BNPL Transaction
Authorize BNPL Transaction
409
No Sufficient Balance
{"trace_id": "<uuid>", "data": {"status": 0}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"trace_id": {"type": "string"}, "data": {"type": "object", "properties": {"status": {"type": "integer"}}, "required": ["status"]}}, "required": ["data", "trace_id"]}
fa28705d-1d3d-4cf9-904b-9bb39e144281/a51b888f-d20b-4ddd-bde5-0c1e316c4043/0/0
BNPL Management
BNPL Management
null
Pre-authorize BNPL Transaction
Pre-authorize BNPL Transaction
403
Not Allowed
{"trace_id": "<uuid>", "data": {"status": 0}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"trace_id": {"type": "string"}, "data": {"type": "object", "properties": {"status": {"type": "integer"}}, "required": ["status"]}}, "required": ["data", "trace_id"]}
fa28705d-1d3d-4cf9-904b-9bb39e144281/a51b888f-d20b-4ddd-bde5-0c1e316c4043/1/0
BNPL Management
BNPL Management
null
Pre-authorize BNPL Transaction
Pre-authorize BNPL Transaction
200
Success while Pre-authorize
{"trace_id": "<uuid>", "data": {"transaction_ext_id": "<uuid>", "status": 1}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"trace_id": {"type": "string"}, "data": {"type": "object", "properties": {"transaction_ext_id": {"type": "string"}, "status": {"type": "integer"}}, "required": ["status", "transaction_ext_id"]}}, "required": ["data", "trace_id"]}
fa28705d-1d3d-4cf9-904b-9bb39e144281/a51b888f-d20b-4ddd-bde5-0c1e316c4043/2/0
BNPL Management
BNPL Management
null
Pre-authorize BNPL Transaction
Pre-authorize BNPL Transaction
409
No Sufficient Balance
{"trace_id": "<uuid>", "data": {"status": 0}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"trace_id": {"type": "string"}, "data": {"type": "object", "properties": {"status": {"type": "integer"}}, "required": ["status"]}}, "required": ["data", "trace_id"]}
fa28705d-1d3d-4cf9-904b-9bb39e144281/95aab31e-165d-4c4c-97a8-c1005bc0aeba/0/0
BNPL Management
BNPL Management
null
Get Special Offer IDs Associated with Commerce Transaction
Get Special Offer IDs Associated with Commerce Transaction
404
New Example
{"trace_id": "<uuid>", "data": {"offers": []}}
{"type": "object", "properties": {"trace_id": {"type": "string"}, "data": {"type": "object", "properties": {"offers": {"type": "array"}}}}}
fa28705d-1d3d-4cf9-904b-9bb39e144281/95aab31e-165d-4c4c-97a8-c1005bc0aeba/1/0
BNPL Management
BNPL Management
null
Get Special Offer IDs Associated with Commerce Transaction
Get Special Offer IDs Associated with Commerce Transaction
200
New Example
{"trace_id": "<uuid>", "data": {"offers": ["23432423423423", "4234235234535345"]}}
{"type": "object", "properties": {"trace_id": {"type": "string"}, "data": {"type": "object", "properties": {"offers": {"type": "array", "items": {"type": "string"}}}}}}
fa28705d-1d3d-4cf9-904b-9bb39e144281/e7445c31-e8bc-4f46-b64e-3a017cb33d12/0/0
BNPL Management
BNPL Management
null
Get Customer BNPL State
Get Customer BNPL State
404
New Example
{"trace_id": "<uuid>", "data": {"status": 0}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"trace_id": {"type": "string"}, "data": {"type": "object", "properties": {"status": {"type": "integer"}}, "required": ["status"]}}, "required": ["data", "trace_id"]}
fa28705d-1d3d-4cf9-904b-9bb39e144281/e7445c31-e8bc-4f46-b64e-3a017cb33d12/1/0
BNPL Management
BNPL Management
null
Get Customer BNPL State
Get Customer BNPL State
403
BNPL Was Active, but blocked
{"trace_id": "<uuid>", "data": {"status": 2}}
{"type": "object", "properties": {"trace_id": {"type": "string"}, "data": {"type": "object", "properties": {"status": {"type": "integer"}}}}}
fa28705d-1d3d-4cf9-904b-9bb39e144281/e7445c31-e8bc-4f46-b64e-3a017cb33d12/2/0
BNPL Management
BNPL Management
null
Get Customer BNPL State
Get Customer BNPL State
200
Customer Has BNPL Status and Balance
{"trace_id": "<uuid>", "data": {"status": 1, "available_amount": 550.4, "currency": "AZN"}}
{"type": "object", "properties": {"trace_id": {"type": "string"}, "data": {"type": "object", "properties": {"status": {"type": "integer"}, "available_amount": {"type": "number"}, "currency": {"type": "string"}}}}}
1d4bb0ab-2f21-4d0b-9233-06c6583684fa/3e8c2d35-50af-4f65-88c6-bc98b3829952/0/0
Thremapi
Simple threat modeling for REST API based on OpenAPI/Swagger specification
0.2
analyzeOpenApiSpec
Sends OpenAPI/Swagger specification for analysis
202
Example_1
{"servers": [{"description": "", "types": []}], "paths": {"items": {"description": "", "types": []}}, "components": {"items": {"description": "", "types": []}}, "errors": []}
{"type": "object", "properties": {"servers": {"type": "array", "items": {"type": "object", "properties": {"description": {"type": "string"}, "types": {"uniqueItems": true, "type": "array", "items": {"type": "object"}}}}}, "paths": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "object", "properties": {"description": {"type": "string"}, "types": {"uniqueItems": true, "type": "array", "items": {"type": "object"}}}}}}, "components": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "object", "properties": {"description": {"type": "string"}, "types": {"uniqueItems": true, "type": "array", "items": {"type": "object"}}}}}}, "errors": {"type": "array", "items": {"type": "string"}}}}
b92568eb-1dcf-41cd-a06a-8fc977b20556/cb939936-d170-40b3-adb3-27ea432ab969/0/0
Inkit
Generate documents automatically, secure PDFs, and centralize document retention.
0.2
/v1/render/{renderId}
200
null
{"id": "rend_3ykhDs8uw0bLCZ6HkDwsAq", "folder_id": "fold_3ykhDs8uw0bLCZ6HkDwsAq", "status": "processing", "created_at": "Tue, 23 Mar 2021 11:43:57 GMT", "updated_at": "Tue, 23 Mar 2021 11:43:57 GMT", "html": "<html>Hello World</html>", "unit": "in", "width": 8.5, "height": 11, "pdf_url": "https://api.inkit.com/v1/render/rend_3ykhDs8uw0bLCZ6HkDwsAq/pdf"}
{"type": "object", "properties": {"id": {"type": "string"}, "folder_id": {"type": "string"}, "status": {"type": "string"}, "created_at": {"type": "string"}, "updated_at": {"type": "string"}, "html": {"type": "string"}, "unit": {"type": "string"}, "width": {"type": "number"}, "height": {"type": "number"}, "pdf_url": {"type": "string"}}}
b92568eb-1dcf-41cd-a06a-8fc977b20556/e8b6972b-67ab-4c5b-8c54-169cdfa0c71c/0/0
Inkit
Generate documents automatically, secure PDFs, and centralize document retention.
0.2
/v1/render
200
null
[{"id": "rend_3ykhDs8uw0bLCZ6HkDwsAq", "folder_id": "fold_3ykhDs8uw0bLCZ6HkDwsAq", "status": "processing", "created_at": "Tue, 23 Mar 2021 11:43:57 GMT", "updated_at": "Tue, 23 Mar 2021 11:43:57 GMT", "html": "<html>Hello World</html>", "unit": "in", "width": 8.5, "height": 11, "pdf_url": "https://api.inkit.com/v1/render/rend_3ykhDs8uw0bLCZ6HkDwsAq/pdf"}]
{"type": "array", "items": {"properties": {"id": {"type": "string"}, "folder_id": {"type": "string"}, "status": {"type": "string"}, "created_at": {"type": "string"}, "updated_at": {"type": "string"}, "html": {"type": "string"}, "unit": {"type": "string"}, "width": {"type": "number"}, "height": {"type": "number"}, "pdf_url": {"type": "string"}}}}
067671e9-f3e4-4165-83a1-b565fd404fe3/44d121bb-a5e6-44dc-b822-2483009100b3/0/0
magnus
magnus
null
getVersionDetailsv2
200
null
{"version": {"status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "media-types": [{"base": "application/xml", "type": "application/vnd.openstack.compute+xml;version=2"}, {"base": "application/json", "type": "application/vnd.openstack.compute+json;version=2"}], "id": "v2.0", "links": [{"href": "http://127.0.0.1:8774/v2/", "rel": "self"}, {"href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", "type": "application/pdf", "rel": "describedby"}, {"href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", "type": "application/vnd.sun.wadl+xml", "rel": "describedby"}, {"href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", "type": "application/vnd.sun.wadl+xml", "rel": "describedby"}]}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"version": {"type": "object", "properties": {"status": {"type": "string"}, "updated": {"type": "string"}, "media-types": {"type": "array", "items": {"type": "object", "properties": {"base": {"type": "string"}, "type": {"type": "string"}}, "required": ["base", "type"]}}, "id": {"type": "string"}, "links": {"type": "array", "items": {"type": "object", "properties": {"href": {"type": "string"}, "rel": {"type": "string"}, "type": {"type": "string"}}, "required": ["href", "rel"]}}}, "required": ["id", "links", "media-types", "status", "updated"]}}, "required": ["version"]}
067671e9-f3e4-4165-83a1-b565fd404fe3/44d121bb-a5e6-44dc-b822-2483009100b3/1/0
magnus
magnus
null
getVersionDetailsv2
203
null
{"version": {"status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "media-types": [{"base": "application/xml", "type": "application/vnd.openstack.compute+xml;version=2"}, {"base": "application/json", "type": "application/vnd.openstack.compute+json;version=2"}], "id": "v2.0", "links": [{"href": "http://23.253.228.211:8774/v2/", "rel": "self"}, {"href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", "type": "application/pdf", "rel": "describedby"}, {"href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", "type": "application/vnd.sun.wadl+xml", "rel": "describedby"}]}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"version": {"type": "object", "properties": {"status": {"type": "string"}, "updated": {"type": "string"}, "media-types": {"type": "array", "items": {"type": "object", "properties": {"base": {"type": "string"}, "type": {"type": "string"}}, "required": ["base", "type"]}}, "id": {"type": "string"}, "links": {"type": "array", "items": {"type": "object", "properties": {"href": {"type": "string"}, "rel": {"type": "string"}, "type": {"type": "string"}}, "required": ["href", "rel"]}}}, "required": ["id", "links", "media-types", "status", "updated"]}}, "required": ["version"]}
067671e9-f3e4-4165-83a1-b565fd404fe3/3670030a-29c7-4d86-8e0b-d5c4d6fb4b25/1/0
magnus
magnus
null
listVersionsv2
200
null
{"versions": [{"status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "id": "v2.0", "links": [{"href": "http://127.0.0.1:8774/v2/", "rel": "self"}]}, {"status": "EXPERIMENTAL", "updated": "2013-07-23T11:33:21Z", "id": "v3.0", "links": [{"href": "http://127.0.0.1:8774/v3/", "rel": "self"}]}]}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"versions": {"type": "array", "items": {"type": "object", "properties": {"status": {"type": "string"}, "updated": {"type": "string"}, "id": {"type": "string"}, "links": {"type": "array", "items": {"type": "object", "properties": {"href": {"type": "string"}, "rel": {"type": "string"}}, "required": ["href", "rel"]}}}, "required": ["id", "links", "status", "updated"]}}}, "required": ["versions"]}
03bdccff-d0da-4191-9816-7830cefb2398/1fa85cce-ba89-49c0-95e8-fbc2bd152285/1/0
ESS API
ESS API
null
transform
200
null
{"successful": true, "fileDto": {"filename": "", "content": "", "checksum": ""}, "message": "", "mimeType": ""}
{"type": "object", "properties": {"successful": {"type": "boolean"}, "fileDto": {"type": "object", "properties": {"filename": {"type": "string"}, "content": {"type": "string"}, "checksum": {"type": "string"}}}, "message": {"type": "string"}, "mimeType": {"type": "string"}}}
03bdccff-d0da-4191-9816-7830cefb2398/dcaa6c78-da32-4aa8-b7e3-8caf4efc8a20/1/0
ESS API
ESS API
null
extract
200
null
{"successful": true, "result": "", "message": ""}
{"type": "object", "properties": {"successful": {"type": "boolean"}, "result": {"type": "string"}, "message": {"type": "string"}}}
304666f1-a8bd-491d-b57e-bee5edae2699/85d82b77-3e42-414c-b60a-02af6a872033/0/0
Print your own labels and stickers
Help your customers print their own labels and stickers, from your own website and under your own branding.
8.1
Label templates
List of label templates filtered by one or more of the following parameters: paper format template brand exact label size approximate label size label shape
200
New Example
{"key1": "value", "key2": "value"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
304666f1-a8bd-491d-b57e-bee5edae2699/74bd0497-015d-48d6-9218-33cf9b0593de/0/0
Print your own labels and stickers
Help your customers print their own labels and stickers, from your own website and under your own branding.
8.1
Print on dynamically generated label templates
Generates the PDF file which contains the printout of labels. The label template will be generated on the fly, based on the label layout dimensions that you will supply on every request. The content printed on each label, is the image whose URL is supplied by labelContent query parameter.
200
New Example
{"key1": "value", "key2": "value"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
304666f1-a8bd-491d-b57e-bee5edae2699/5cb1c6e8-8cf6-4df0-9599-a7c0c10e17dd/0/0
Print your own labels and stickers
Help your customers print their own labels and stickers, from your own website and under your own branding.
8.1
Print on label templates or plain paper
Generates the PDF file which contains the printout of labels. Label layout conforms the label template and three print setup query parameters. The content printed on each label, is the image whose URL is supplied by labelContent query parameter.
200
New Example
{"key1": "value", "key2": "value"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
304666f1-a8bd-491d-b57e-bee5edae2699/64a51537-6ec4-4a32-8ef1-83f29dd0b9db/0/0
Print your own labels and stickers
Help your customers print their own labels and stickers, from your own website and under your own branding.
8.1
Label shapes
List of available label shapes.
200
New Example
{"key1": "value", "key2": "value"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
304666f1-a8bd-491d-b57e-bee5edae2699/bbccc1ea-835e-4485-b849-7ebc5784999a/0/0
Print your own labels and stickers
Help your customers print their own labels and stickers, from your own website and under your own branding.
8.1
Label sizes
Returns a list of label sizes in the format [width]x[height]. These sizes are rounded, meaning that they can represent a few other sizes that are close to them. For example size 4"x3", will represent 3.75"x3", 4"x3.25" and so on.
200
New Example
{"key1": "value", "key2": "value"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
e0cb3a86-9438-46e6-b4c8-6a144116584b/672cf5f9-ea21-481e-ae9d-a5803146ac7b/0/0
QR URL Tracker API
QR Code URL Tracker
null
QR URL Tracker
The QR URL Tracker allows developers and users to create URL embedded QR Codes real time that can be tracked as per usage. The QR Codes can be visually customised by Colors, add Logo's, change size of the logo and where it is placed on the QR Image
200
New Example
{"status": "", "errcode": "", "qrurl": "", "pointsremaining": "", "campaignurl": "", "trackid": ""}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"status": {"type": "string"}, "errcode": {"type": "string"}, "qrurl": {"type": "string"}, "pointsremaining": {"type": "string"}, "campaignurl": {"type": "string"}, "trackid": {"type": "string"}}, "required": ["campaignurl", "errcode", "pointsremaining", "qrurl", "status", "trackid"]}
92d37070-7be0-4cfb-8ddf-007e912a8de1/5837300a-49ba-408f-b49f-ca1b6a2bd9bc/0/0
informatron - logo - colors and infos scraper
Enrich your data with just an email or a domain. Personnalize your users onboarding with their colors, logo, company description and much more.
null
Get domain infos from a simple url or email - POST version
Same request than GET /domain/infos/{urlOrEmail} but with a POST so it's more resilient for passing domains including special characters (especially slashes /).
200
Response
{"title": "Stack Overflow - Where Developers Learn, Share, & Build Careers", "description": "Stack Overflow | The World\u2019s Largest Online Community for Developers", "image": "https://cdn.sstatic.net/Sites/stackoverflow/Img/[email protected]?v=73d79a89bded", "logo": "https://logo.clearbit.com/stackoverflow.com", "publisher": "Stack Overflow", "url": "https://stackoverflow.com", "author": null, "date": null, "lang": null, "files": ["https://cdn.sstatic.net/Sites/stackoverflow/Img/favicon.ico?v=ec617d715196", "https://cdn.sstatic.net/Sites/stackoverflow/Img/apple-touch-icon.png?v=c78bd457575a", "https://cdn.sstatic.net/Sites/stackoverflow/Img/apple-touch-icon.png?v=c78bd457575a", "https://stackoverflow.com/opensearch.xml", "https://cdn.sstatic.net/Shared/stacks.css?v=9b3c752346b4", "https://cdn.sstatic.net/Sites/stackoverflow/primary.css?v=a8e5d46c6c14", "https://cdn.sstatic.net/Shared/Product/product.css?v=f5d2db9a2252", "https://stackoverflow.com/feeds", "https://cdn.sstatic.net/Shared/Channels/channels.css?v=b1915d2e6090", "https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js", "https://cdn.sstatic.net/Js/third-party/stacks/stacks.min.js?v=636658ad2e24", "https://cdn.sstatic.net/Js/stub.en.js?v=fce5f0cba23f", "https://cdn.sstatic.net/Js/product/animations.en.js?v=660a00b4b4f3", "https://cdn.sstatic.net/Js/product/lazy-load-images.en.js?v=767e999ba5d5"], "name": "Stack Overflow", "palette": [{"_rgb": [244, 136, 48], "_population": 35, "_hsl": [0.0748299319727891, 0.8990825688073396, 0.5725490196078431], "model": "rgb", "color": [244, 136, 48], "valpha": 1, "isLightColor": true, "luminosity": 0.3705481579834121, "stringRgb": "rgb(244, 136, 48)", "colorType": "Vibrant"}, {"_rgb": [125.90917431192662, 60.21743119266055, 6.6908256880733825], "_population": 0, "_hsl": [0.0748299319727891, 0.8990825688073396, 0.26], "model": "rgb", "color": [125.90917431192662, 60.21743119266055, 6.6908256880733825], "valpha": 1, "isLightColor": false, "luminosity": 0.0769792662170794, "stringRgb": "rgb(126, 60, 7)", "colorType": "DarkVibrant"}, {"_rgb": [252, 182, 129], "_population": 16, "_hsl": [0.07181571815718157, 0.9534883720930234, 0.7470588235294118], "model": "rgb", "color": [252, 182, 129], "valpha": 1, "isLightColor": true, "luminosity": 0.5573632313385718, "stringRgb": "rgb(252, 182, 129)", "colorType": "LightVibrant"}, {"_rgb": [145.27981651376146, 69.48165137614677, 7.7201834862385255], "_population": 0, "model": "rgb", "color": [145.27981651376146, 69.48165137614677, 7.7201834862385255], "valpha": 1, "isLightColor": false, "luminosity": 0.10377857900078619, "stringRgb": "rgb(145, 70, 8)", "colorType": "Muted"}, {"_rgb": [145.27981651376146, 69.48165137614677, 7.7201834862385255], "_population": 0, "model": "rgb", "color": [145.27981651376146, 69.48165137614677, 7.7201834862385255], "valpha": 1, "isLightColor": false, "luminosity": 0.10377857900078619, "stringRgb": "rgb(145, 70, 8)", "colorType": "DarkMuted"}, {"_rgb": [188, 188, 188], "_population": 21, "_hsl": [0, 0, 0.7372549019607844], "model": "rgb", "color": [188, 188, 188], "valpha": 1, "isLightColor": true, "luminosity": 0.5028864580325687, "stringRgb": "rgb(188, 188, 188)", "colorType": "LightMuted"}]}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"title": {"type": "string"}, "description": {"type": "string"}, "image": {"type": "string"}, "logo": {"type": "string"}, "publisher": {"type": "string"}, "url": {"type": "string"}, "author": {"type": "null"}, "date": {"type": "null"}, "lang": {"type": "null"}, "files": {"type": "array", "items": {"type": "string"}}, "name": {"type": "string"}, "palette": {"type": "array", "items": {"type": "object", "properties": {"_rgb": {"type": "array", "items": {"type": "number"}}, "_population": {"type": "integer"}, "_hsl": {"type": "array", "items": {"type": "number"}}, "model": {"type": "string"}, "color": {"type": "array", "items": {"type": "number"}}, "valpha": {"type": "integer"}, "isLightColor": {"type": "boolean"}, "luminosity": {"type": "number"}, "stringRgb": {"type": "string"}, "colorType": {"type": "string"}}, "required": ["_population", "_rgb", "color", "colorType", "isLightColor", "luminosity", "model", "stringRgb", "valpha"]}}}, "required": ["author", "date", "description", "files", "image", "lang", "logo", "name", "palette", "publisher", "title", "url"]}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/f641a2f6-47fa-40d7-bb52-1cb2a3488450/0/0
Altoviz
Invoicing and accounting APIs
null
GET_Hello_Get
401
null
{"type": "", "title": "", "status": 0, "detail": "", "instance": ""}
{"type": "object", "properties": {"type": {"type": ["string", "null"]}, "title": {"type": ["string", "null"]}, "status": {"type": ["integer", "null"], "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "detail": {"type": ["string", "null"]}, "instance": {"type": ["string", "null"]}}, "additionalProperties": {}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/f641a2f6-47fa-40d7-bb52-1cb2a3488450/1/0
Altoviz
Invoicing and accounting APIs
null
GET_Hello_Get
401
null
{"type": "", "title": "", "status": 0, "detail": "", "instance": ""}
{"type": "object", "properties": {"type": {"type": ["string", "null"]}, "title": {"type": ["string", "null"]}, "status": {"type": ["integer", "null"], "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "detail": {"type": ["string", "null"]}, "instance": {"type": ["string", "null"]}}, "additionalProperties": {}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/52562bf8-7687-4e89-8f1c-b361ddda4737/0/0
Altoviz
Invoicing and accounting APIs
null
GET_Vats_List
200
null
[{"id": 0, "rate": 0, "region": "FR", "label": ""}]
{"type": "array", "items": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/cfce580e-e10c-4b9c-b3da-0a5e2b068397/0/0
Altoviz
Invoicing and accounting APIs
null
GET_Products_Get
200
null
{"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}
{"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/cfce580e-e10c-4b9c-b3da-0a5e2b068397/1/0
Altoviz
Invoicing and accounting APIs
null
GET_Products_Get
404
null
{"type": "", "title": "", "status": 0, "detail": "", "instance": ""}
{"type": "object", "properties": {"type": {"type": ["string", "null"]}, "title": {"type": ["string", "null"]}, "status": {"type": ["integer", "null"], "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "detail": {"type": ["string", "null"]}, "instance": {"type": ["string", "null"]}}, "additionalProperties": {}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/e41cbb43-315d-4868-a0e8-2e7c13a5427f/0/0
Altoviz
Invoicing and accounting APIs
null
PUT_Products_Update
200
null
{"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}
{"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/2e8b0bf5-c00e-4cf5-97c4-8ca82740f889/0/0
Altoviz
Invoicing and accounting APIs
null
GET_Products_Find
200
null
[{"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}]
{"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/678f525b-3743-4b9d-84dd-d24bb9280b96/0/0
Altoviz
Invoicing and accounting APIs
null
GET_Classifications_List
200
null
[{"id": 0, "label": "", "description": "", "accountNumber": "", "defaultVat": {"id": 0, "rate": 0, "region": "FR", "label": ""}, "isProduct": true, "isService": true, "type": "Sale", "microBusinessDeclarationType": "Products"}]
{"type": "array", "items": {"required": ["label", "type"], "type": "object", "properties": {"id": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "label": {"minLength": 1, "type": "string", "description": "Label"}, "description": {"type": ["string", "null"], "description": "Description"}, "accountNumber": {"type": ["string", "null"], "description": "Account number"}, "defaultVat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}, "isProduct": {"type": "boolean", "description": "Indicates whether classification is product (should be defined when type is 'Sale')"}, "isService": {"type": "boolean", "description": "Indicates whether classification is service (should be defined when type is 'Sale')"}, "type": {"enum": ["Sale", "Expense", "Other"], "type": "string"}, "microBusinessDeclarationType": {"enum": ["Products", "Services", "OtherServices", "Renting", "Cipav"], "type": "string"}}, "additionalProperties": false, "description": "Classification"}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/f3b73d4f-a5a6-4d8b-80ca-f07898d4a804/0/0
Altoviz
Invoicing and accounting APIs
null
POST_Products_Post
400
null
{"message": "", "errors": []}
{"type": "object", "properties": {"message": {"type": ["string", "null"], "description": "Error message"}, "errors": {"type": ["array", "null"], "items": {"type": "string"}, "description": "List of error messages"}}, "additionalProperties": false, "description": "Error"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/f3b73d4f-a5a6-4d8b-80ca-f07898d4a804/1/0
Altoviz
Invoicing and accounting APIs
null
POST_Products_Post
200
null
{"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}
{"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/2515987d-c3df-4d2b-ba00-83d990bdeabb/0/0
Altoviz
Invoicing and accounting APIs
null
GET_SaleQuotes_List
200
null
[{"status": "Pending", "validityDate": "", "deposit": {"type": "Percent", "value": 0}, "id": 0, "number": "", "date": "", "customerId": 0, "customerNumber": "", "customerName": "", "customerVatNumber": "", "customerOrderReference": "", "billingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "subject": "", "useTaxIncludedPrices": true, "vatReverseCharge": true, "lines": [{"id": 0, "description": "", "taxExcludedPrice": 0, "taxIncludedPrice": 0, "quantity": 0, "classificationId": 0, "taxExcludedAmount": 0, "taxIncludedAmount": 0, "vatId": 0, "discount": {"type": "Percent", "value": 0}, "date": "", "type": "Empty", "productId": 0, "productNumber": "", "purchasePrice": 0, "marginRate": 0, "marginAmount": 0, "disbursement": true, "product": {"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}], "grossTaxExcludedAmount": 0, "globalDiscount": {"type": "Percent", "value": 0}, "taxExcludedAmount": 0, "shippingAmount": 0, "shippingVatId": 0, "taxAmount": 0, "dueAmount": 0, "taxIncludedAmount": 0, "notes": "", "vendorReference": "", "pdfUrl": ""}]
{"type": "array", "items": {"required": ["customerId"], "type": "object", "properties": {"status": {"enum": ["Pending", "Accepted", "Refused", "Closed", "Sent", "Invoiced"], "type": "string"}, "validityDate": {"type": ["string", "null"], "description": "Validity date", "format": "date"}, "deposit": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "id": {"type": ["integer", "null"], "description": "Invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "number": {"type": ["string", "null"], "description": "Number"}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "customerId": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "customerNumber": {"type": ["string", "null"], "description": "Customer number"}, "customerName": {"type": ["string", "null"], "description": "Customer name"}, "customerVatNumber": {"type": ["string", "null"], "description": "Customer VAT number"}, "customerOrderReference": {"type": ["string", "null"], "description": "Customer order reference"}, "billingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "subject": {"type": ["string", "null"], "description": "Subject"}, "useTaxIncludedPrices": {"type": "boolean", "description": "Indicates whether invoice prices and amount are tax included"}, "vatReverseCharge": {"type": "boolean", "description": "VAT reverse charge"}, "lines": {"type": ["array", "null"], "items": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Invoice line ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "description": {"type": ["string", "null"], "description": "Description (can be html)"}, "taxExcludedPrice": {"type": ["number", "null"], "description": "Tax excluded price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedPrice": {"type": ["number", "null"], "description": "Tax included price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "quantity": {"type": ["number", "null"], "description": "Quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "classificationId": {"type": ["integer", "null"], "description": "Classification ID (should be defined if line is product or service)", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxExcludedAmount": {"type": ["number", "null"], "description": "Tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": ["number", "null"], "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "type": {"enum": ["Empty", "Product", "Service", "Subtotal", "Text", "Deposit", "NewPage", "Title"], "type": "string"}, "productId": {"type": ["integer", "null"], "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "productNumber": {"type": ["string", "null"], "description": "Product number"}, "purchasePrice": {"type": ["number", "null"], "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginRate": {"type": "number", "description": "Margin rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginAmount": {"type": "number", "description": "Margin amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "disbursement": {"type": "boolean", "description": "Disbursement"}, "product": {"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Invoice line"}, "description": "Invoice lines"}, "grossTaxExcludedAmount": {"type": "number", "description": "Gross tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "globalDiscount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "taxExcludedAmount": {"type": "number", "description": "Tax excluded amount (discount included)", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingAmount": {"type": "number", "description": "Shipping amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingVatId": {"type": ["integer", "null"], "description": "Shipping VAT ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxAmount": {"type": "number", "description": "Total tax amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "dueAmount": {"type": "number", "description": "Total due", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": "number", "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "notes": {"type": ["string", "null"], "description": "Notes to be print"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference to be print"}, "pdfUrl": {"type": ["string", "null"], "description": "Pdf url"}}, "additionalProperties": false, "description": "Quote"}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/2515987d-c3df-4d2b-ba00-83d990bdeabb/1/0
Altoviz
Invoicing and accounting APIs
null
GET_SaleQuotes_List
200
null
[{"status": "Pending", "validityDate": "", "deposit": {"type": "Percent", "value": 0}, "id": 0, "number": "", "date": "", "customerId": 0, "customerNumber": "", "customerName": "", "customerVatNumber": "", "customerOrderReference": "", "billingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "subject": "", "useTaxIncludedPrices": true, "vatReverseCharge": true, "lines": [{"id": 0, "description": "", "taxExcludedPrice": 0, "taxIncludedPrice": 0, "quantity": 0, "classificationId": 0, "taxExcludedAmount": 0, "taxIncludedAmount": 0, "vatId": 0, "discount": {"type": "Percent", "value": 0}, "date": "", "type": "Empty", "productId": 0, "productNumber": "", "purchasePrice": 0, "marginRate": 0, "marginAmount": 0, "disbursement": true, "product": {"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}], "grossTaxExcludedAmount": 0, "globalDiscount": {"type": "Percent", "value": 0}, "taxExcludedAmount": 0, "shippingAmount": 0, "shippingVatId": 0, "taxAmount": 0, "dueAmount": 0, "taxIncludedAmount": 0, "notes": "", "vendorReference": "", "pdfUrl": ""}]
{"type": "array", "items": {"required": ["customerId"], "type": "object", "properties": {"status": {"enum": ["Pending", "Accepted", "Refused", "Closed", "Sent", "Invoiced"], "type": "string"}, "validityDate": {"type": ["string", "null"], "description": "Validity date", "format": "date"}, "deposit": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "id": {"type": ["integer", "null"], "description": "Invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "number": {"type": ["string", "null"], "description": "Number"}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "customerId": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "customerNumber": {"type": ["string", "null"], "description": "Customer number"}, "customerName": {"type": ["string", "null"], "description": "Customer name"}, "customerVatNumber": {"type": ["string", "null"], "description": "Customer VAT number"}, "customerOrderReference": {"type": ["string", "null"], "description": "Customer order reference"}, "billingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "subject": {"type": ["string", "null"], "description": "Subject"}, "useTaxIncludedPrices": {"type": "boolean", "description": "Indicates whether invoice prices and amount are tax included"}, "vatReverseCharge": {"type": "boolean", "description": "VAT reverse charge"}, "lines": {"type": ["array", "null"], "items": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Invoice line ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "description": {"type": ["string", "null"], "description": "Description (can be html)"}, "taxExcludedPrice": {"type": ["number", "null"], "description": "Tax excluded price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedPrice": {"type": ["number", "null"], "description": "Tax included price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "quantity": {"type": ["number", "null"], "description": "Quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "classificationId": {"type": ["integer", "null"], "description": "Classification ID (should be defined if line is product or service)", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxExcludedAmount": {"type": ["number", "null"], "description": "Tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": ["number", "null"], "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "type": {"enum": ["Empty", "Product", "Service", "Subtotal", "Text", "Deposit", "NewPage", "Title"], "type": "string"}, "productId": {"type": ["integer", "null"], "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "productNumber": {"type": ["string", "null"], "description": "Product number"}, "purchasePrice": {"type": ["number", "null"], "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginRate": {"type": "number", "description": "Margin rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginAmount": {"type": "number", "description": "Margin amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "disbursement": {"type": "boolean", "description": "Disbursement"}, "product": {"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Invoice line"}, "description": "Invoice lines"}, "grossTaxExcludedAmount": {"type": "number", "description": "Gross tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "globalDiscount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "taxExcludedAmount": {"type": "number", "description": "Tax excluded amount (discount included)", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingAmount": {"type": "number", "description": "Shipping amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingVatId": {"type": ["integer", "null"], "description": "Shipping VAT ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxAmount": {"type": "number", "description": "Total tax amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "dueAmount": {"type": "number", "description": "Total due", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": "number", "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "notes": {"type": ["string", "null"], "description": "Notes to be print"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference to be print"}, "pdfUrl": {"type": ["string", "null"], "description": "Pdf url"}}, "additionalProperties": false, "description": "Quote"}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/3f5f6765-bcbe-432e-a927-fe5eff3174c2/0/0
Altoviz
Invoicing and accounting APIs
null
GET_Contacts_Get
200
null
{"id": 0, "title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}
{"type": "object", "properties": {"id": {"type": "integer", "description": "Contact ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false, "description": "Contact"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/5d1d6f81-5cf3-4201-9188-6ab2922fc370/0/0
Altoviz
Invoicing and accounting APIs
null
GET_SaleQuotes_Get
200
null
{"status": "Pending", "validityDate": "", "deposit": {"type": "Percent", "value": 0}, "id": 0, "number": "", "date": "", "customerId": 0, "customerNumber": "", "customerName": "", "customerVatNumber": "", "customerOrderReference": "", "billingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "subject": "", "useTaxIncludedPrices": true, "vatReverseCharge": true, "lines": [{"id": 0, "description": "", "taxExcludedPrice": 0, "taxIncludedPrice": 0, "quantity": 0, "classificationId": 0, "taxExcludedAmount": 0, "taxIncludedAmount": 0, "vatId": 0, "discount": {"type": "Percent", "value": 0}, "date": "", "type": "Empty", "productId": 0, "productNumber": "", "purchasePrice": 0, "marginRate": 0, "marginAmount": 0, "disbursement": true, "product": {"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}], "grossTaxExcludedAmount": 0, "globalDiscount": {"type": "Percent", "value": 0}, "taxExcludedAmount": 0, "shippingAmount": 0, "shippingVatId": 0, "taxAmount": 0, "dueAmount": 0, "taxIncludedAmount": 0, "notes": "", "vendorReference": "", "pdfUrl": ""}
{"required": ["customerId"], "type": "object", "properties": {"status": {"enum": ["Pending", "Accepted", "Refused", "Closed", "Sent", "Invoiced"], "type": "string"}, "validityDate": {"type": ["string", "null"], "description": "Validity date", "format": "date"}, "deposit": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "id": {"type": ["integer", "null"], "description": "Invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "number": {"type": ["string", "null"], "description": "Number"}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "customerId": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "customerNumber": {"type": ["string", "null"], "description": "Customer number"}, "customerName": {"type": ["string", "null"], "description": "Customer name"}, "customerVatNumber": {"type": ["string", "null"], "description": "Customer VAT number"}, "customerOrderReference": {"type": ["string", "null"], "description": "Customer order reference"}, "billingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "subject": {"type": ["string", "null"], "description": "Subject"}, "useTaxIncludedPrices": {"type": "boolean", "description": "Indicates whether invoice prices and amount are tax included"}, "vatReverseCharge": {"type": "boolean", "description": "VAT reverse charge"}, "lines": {"type": ["array", "null"], "items": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Invoice line ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "description": {"type": ["string", "null"], "description": "Description (can be html)"}, "taxExcludedPrice": {"type": ["number", "null"], "description": "Tax excluded price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedPrice": {"type": ["number", "null"], "description": "Tax included price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "quantity": {"type": ["number", "null"], "description": "Quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "classificationId": {"type": ["integer", "null"], "description": "Classification ID (should be defined if line is product or service)", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxExcludedAmount": {"type": ["number", "null"], "description": "Tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": ["number", "null"], "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "type": {"enum": ["Empty", "Product", "Service", "Subtotal", "Text", "Deposit", "NewPage", "Title"], "type": "string"}, "productId": {"type": ["integer", "null"], "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "productNumber": {"type": ["string", "null"], "description": "Product number"}, "purchasePrice": {"type": ["number", "null"], "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginRate": {"type": "number", "description": "Margin rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginAmount": {"type": "number", "description": "Margin amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "disbursement": {"type": "boolean", "description": "Disbursement"}, "product": {"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Invoice line"}, "description": "Invoice lines"}, "grossTaxExcludedAmount": {"type": "number", "description": "Gross tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "globalDiscount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "taxExcludedAmount": {"type": "number", "description": "Tax excluded amount (discount included)", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingAmount": {"type": "number", "description": "Shipping amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingVatId": {"type": ["integer", "null"], "description": "Shipping VAT ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxAmount": {"type": "number", "description": "Total tax amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "dueAmount": {"type": "number", "description": "Total due", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": "number", "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "notes": {"type": ["string", "null"], "description": "Notes to be print"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference to be print"}, "pdfUrl": {"type": ["string", "null"], "description": "Pdf url"}}, "additionalProperties": false, "description": "Quote"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/5d1d6f81-5cf3-4201-9188-6ab2922fc370/1/0
Altoviz
Invoicing and accounting APIs
null
GET_SaleQuotes_Get
200
null
{"status": "Pending", "validityDate": "", "deposit": {"type": "Percent", "value": 0}, "id": 0, "number": "", "date": "", "customerId": 0, "customerNumber": "", "customerName": "", "customerVatNumber": "", "customerOrderReference": "", "billingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "subject": "", "useTaxIncludedPrices": true, "vatReverseCharge": true, "lines": [{"id": 0, "description": "", "taxExcludedPrice": 0, "taxIncludedPrice": 0, "quantity": 0, "classificationId": 0, "taxExcludedAmount": 0, "taxIncludedAmount": 0, "vatId": 0, "discount": {"type": "Percent", "value": 0}, "date": "", "type": "Empty", "productId": 0, "productNumber": "", "purchasePrice": 0, "marginRate": 0, "marginAmount": 0, "disbursement": true, "product": {"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}], "grossTaxExcludedAmount": 0, "globalDiscount": {"type": "Percent", "value": 0}, "taxExcludedAmount": 0, "shippingAmount": 0, "shippingVatId": 0, "taxAmount": 0, "dueAmount": 0, "taxIncludedAmount": 0, "notes": "", "vendorReference": "", "pdfUrl": ""}
{"required": ["customerId"], "type": "object", "properties": {"status": {"enum": ["Pending", "Accepted", "Refused", "Closed", "Sent", "Invoiced"], "type": "string"}, "validityDate": {"type": ["string", "null"], "description": "Validity date", "format": "date"}, "deposit": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "id": {"type": ["integer", "null"], "description": "Invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "number": {"type": ["string", "null"], "description": "Number"}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "customerId": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "customerNumber": {"type": ["string", "null"], "description": "Customer number"}, "customerName": {"type": ["string", "null"], "description": "Customer name"}, "customerVatNumber": {"type": ["string", "null"], "description": "Customer VAT number"}, "customerOrderReference": {"type": ["string", "null"], "description": "Customer order reference"}, "billingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "subject": {"type": ["string", "null"], "description": "Subject"}, "useTaxIncludedPrices": {"type": "boolean", "description": "Indicates whether invoice prices and amount are tax included"}, "vatReverseCharge": {"type": "boolean", "description": "VAT reverse charge"}, "lines": {"type": ["array", "null"], "items": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Invoice line ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "description": {"type": ["string", "null"], "description": "Description (can be html)"}, "taxExcludedPrice": {"type": ["number", "null"], "description": "Tax excluded price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedPrice": {"type": ["number", "null"], "description": "Tax included price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "quantity": {"type": ["number", "null"], "description": "Quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "classificationId": {"type": ["integer", "null"], "description": "Classification ID (should be defined if line is product or service)", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxExcludedAmount": {"type": ["number", "null"], "description": "Tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": ["number", "null"], "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "type": {"enum": ["Empty", "Product", "Service", "Subtotal", "Text", "Deposit", "NewPage", "Title"], "type": "string"}, "productId": {"type": ["integer", "null"], "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "productNumber": {"type": ["string", "null"], "description": "Product number"}, "purchasePrice": {"type": ["number", "null"], "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginRate": {"type": "number", "description": "Margin rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginAmount": {"type": "number", "description": "Margin amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "disbursement": {"type": "boolean", "description": "Disbursement"}, "product": {"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Invoice line"}, "description": "Invoice lines"}, "grossTaxExcludedAmount": {"type": "number", "description": "Gross tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "globalDiscount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "taxExcludedAmount": {"type": "number", "description": "Tax excluded amount (discount included)", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingAmount": {"type": "number", "description": "Shipping amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingVatId": {"type": ["integer", "null"], "description": "Shipping VAT ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxAmount": {"type": "number", "description": "Total tax amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "dueAmount": {"type": "number", "description": "Total due", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": "number", "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "notes": {"type": ["string", "null"], "description": "Notes to be print"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference to be print"}, "pdfUrl": {"type": ["string", "null"], "description": "Pdf url"}}, "additionalProperties": false, "description": "Quote"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/dd73e17a-8628-4d03-bdf5-7559f4d9b5fa/0/0
Altoviz
Invoicing and accounting APIs
null
GET_Products_List
200
null
[{"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}]
{"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/ff70c336-f21e-4834-85cc-f3d76925b7ee/0/0
Altoviz
Invoicing and accounting APIs
null
DELETE_Webhooks_Delete
200
null
{"id": 0, "name": "", "secretKey": "", "url": "", "types": ["CustomerCreated"]}
{"required": ["name", "types", "url"], "type": "object", "properties": {"id": {"type": "integer", "description": "Webhook ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"minLength": 1, "type": "string", "description": "Name"}, "secretKey": {"type": ["string", "null"], "description": "Secret key"}, "url": {"minLength": 1, "type": "string", "description": "Webhook Uri"}, "types": {"type": "array", "items": {"enum": ["CustomerCreated", "InvoiceCreated", "CustomerDeleted", "CustomerUpdated", "ProductCreated", "ProductUpdated", "ProductDeleted", "InvoiceUpdated"], "type": "string"}, "description": ""}}, "additionalProperties": false, "description": "Wehbook"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/1eef4270-d890-4838-8022-028bd4c2f4e6/0/0
Altoviz
Invoicing and accounting APIs
null
POST_SaleQuotes_Post
200
null
{"status": "Pending", "validityDate": "", "deposit": {"type": "Percent", "value": 0}, "id": 0, "number": "", "date": "", "customerId": 0, "customerNumber": "", "customerName": "", "customerVatNumber": "", "customerOrderReference": "", "billingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "subject": "", "useTaxIncludedPrices": true, "vatReverseCharge": true, "lines": [{"id": 0, "description": "", "taxExcludedPrice": 0, "taxIncludedPrice": 0, "quantity": 0, "classificationId": 0, "taxExcludedAmount": 0, "taxIncludedAmount": 0, "vatId": 0, "discount": {"type": "Percent", "value": 0}, "date": "", "type": "Empty", "productId": 0, "productNumber": "", "purchasePrice": 0, "marginRate": 0, "marginAmount": 0, "disbursement": true, "product": {"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}], "grossTaxExcludedAmount": 0, "globalDiscount": {"type": "Percent", "value": 0}, "taxExcludedAmount": 0, "shippingAmount": 0, "shippingVatId": 0, "taxAmount": 0, "dueAmount": 0, "taxIncludedAmount": 0, "notes": "", "vendorReference": "", "pdfUrl": ""}
{"required": ["customerId"], "type": "object", "properties": {"status": {"enum": ["Pending", "Accepted", "Refused", "Closed", "Sent", "Invoiced"], "type": "string"}, "validityDate": {"type": ["string", "null"], "description": "Validity date", "format": "date"}, "deposit": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "id": {"type": ["integer", "null"], "description": "Invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "number": {"type": ["string", "null"], "description": "Number"}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "customerId": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "customerNumber": {"type": ["string", "null"], "description": "Customer number"}, "customerName": {"type": ["string", "null"], "description": "Customer name"}, "customerVatNumber": {"type": ["string", "null"], "description": "Customer VAT number"}, "customerOrderReference": {"type": ["string", "null"], "description": "Customer order reference"}, "billingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "subject": {"type": ["string", "null"], "description": "Subject"}, "useTaxIncludedPrices": {"type": "boolean", "description": "Indicates whether invoice prices and amount are tax included"}, "vatReverseCharge": {"type": "boolean", "description": "VAT reverse charge"}, "lines": {"type": ["array", "null"], "items": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Invoice line ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "description": {"type": ["string", "null"], "description": "Description (can be html)"}, "taxExcludedPrice": {"type": ["number", "null"], "description": "Tax excluded price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedPrice": {"type": ["number", "null"], "description": "Tax included price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "quantity": {"type": ["number", "null"], "description": "Quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "classificationId": {"type": ["integer", "null"], "description": "Classification ID (should be defined if line is product or service)", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxExcludedAmount": {"type": ["number", "null"], "description": "Tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": ["number", "null"], "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "type": {"enum": ["Empty", "Product", "Service", "Subtotal", "Text", "Deposit", "NewPage", "Title"], "type": "string"}, "productId": {"type": ["integer", "null"], "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "productNumber": {"type": ["string", "null"], "description": "Product number"}, "purchasePrice": {"type": ["number", "null"], "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginRate": {"type": "number", "description": "Margin rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginAmount": {"type": "number", "description": "Margin amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "disbursement": {"type": "boolean", "description": "Disbursement"}, "product": {"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Invoice line"}, "description": "Invoice lines"}, "grossTaxExcludedAmount": {"type": "number", "description": "Gross tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "globalDiscount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "taxExcludedAmount": {"type": "number", "description": "Tax excluded amount (discount included)", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingAmount": {"type": "number", "description": "Shipping amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingVatId": {"type": ["integer", "null"], "description": "Shipping VAT ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxAmount": {"type": "number", "description": "Total tax amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "dueAmount": {"type": "number", "description": "Total due", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": "number", "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "notes": {"type": ["string", "null"], "description": "Notes to be print"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference to be print"}, "pdfUrl": {"type": ["string", "null"], "description": "Pdf url"}}, "additionalProperties": false, "description": "Quote"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/1eef4270-d890-4838-8022-028bd4c2f4e6/1/0
Altoviz
Invoicing and accounting APIs
null
POST_SaleQuotes_Post
200
null
{"status": "Pending", "validityDate": "", "deposit": {"type": "Percent", "value": 0}, "id": 0, "number": "", "date": "", "customerId": 0, "customerNumber": "", "customerName": "", "customerVatNumber": "", "customerOrderReference": "", "billingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "subject": "", "useTaxIncludedPrices": true, "vatReverseCharge": true, "lines": [{"id": 0, "description": "", "taxExcludedPrice": 0, "taxIncludedPrice": 0, "quantity": 0, "classificationId": 0, "taxExcludedAmount": 0, "taxIncludedAmount": 0, "vatId": 0, "discount": {"type": "Percent", "value": 0}, "date": "", "type": "Empty", "productId": 0, "productNumber": "", "purchasePrice": 0, "marginRate": 0, "marginAmount": 0, "disbursement": true, "product": {"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}], "grossTaxExcludedAmount": 0, "globalDiscount": {"type": "Percent", "value": 0}, "taxExcludedAmount": 0, "shippingAmount": 0, "shippingVatId": 0, "taxAmount": 0, "dueAmount": 0, "taxIncludedAmount": 0, "notes": "", "vendorReference": "", "pdfUrl": ""}
{"required": ["customerId"], "type": "object", "properties": {"status": {"enum": ["Pending", "Accepted", "Refused", "Closed", "Sent", "Invoiced"], "type": "string"}, "validityDate": {"type": ["string", "null"], "description": "Validity date", "format": "date"}, "deposit": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "id": {"type": ["integer", "null"], "description": "Invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "number": {"type": ["string", "null"], "description": "Number"}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "customerId": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "customerNumber": {"type": ["string", "null"], "description": "Customer number"}, "customerName": {"type": ["string", "null"], "description": "Customer name"}, "customerVatNumber": {"type": ["string", "null"], "description": "Customer VAT number"}, "customerOrderReference": {"type": ["string", "null"], "description": "Customer order reference"}, "billingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "subject": {"type": ["string", "null"], "description": "Subject"}, "useTaxIncludedPrices": {"type": "boolean", "description": "Indicates whether invoice prices and amount are tax included"}, "vatReverseCharge": {"type": "boolean", "description": "VAT reverse charge"}, "lines": {"type": ["array", "null"], "items": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Invoice line ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "description": {"type": ["string", "null"], "description": "Description (can be html)"}, "taxExcludedPrice": {"type": ["number", "null"], "description": "Tax excluded price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedPrice": {"type": ["number", "null"], "description": "Tax included price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "quantity": {"type": ["number", "null"], "description": "Quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "classificationId": {"type": ["integer", "null"], "description": "Classification ID (should be defined if line is product or service)", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxExcludedAmount": {"type": ["number", "null"], "description": "Tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": ["number", "null"], "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "type": {"enum": ["Empty", "Product", "Service", "Subtotal", "Text", "Deposit", "NewPage", "Title"], "type": "string"}, "productId": {"type": ["integer", "null"], "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "productNumber": {"type": ["string", "null"], "description": "Product number"}, "purchasePrice": {"type": ["number", "null"], "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginRate": {"type": "number", "description": "Margin rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginAmount": {"type": "number", "description": "Margin amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "disbursement": {"type": "boolean", "description": "Disbursement"}, "product": {"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Invoice line"}, "description": "Invoice lines"}, "grossTaxExcludedAmount": {"type": "number", "description": "Gross tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "globalDiscount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "taxExcludedAmount": {"type": "number", "description": "Tax excluded amount (discount included)", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingAmount": {"type": "number", "description": "Shipping amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingVatId": {"type": ["integer", "null"], "description": "Shipping VAT ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxAmount": {"type": "number", "description": "Total tax amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "dueAmount": {"type": "number", "description": "Total due", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": "number", "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "notes": {"type": ["string", "null"], "description": "Notes to be print"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference to be print"}, "pdfUrl": {"type": ["string", "null"], "description": "Pdf url"}}, "additionalProperties": false, "description": "Quote"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/900846c5-2f3b-497d-8e91-f8033e06b903/0/0
Altoviz
Invoicing and accounting APIs
null
PUT_Contacts_Update
200
null
{"id": 0, "title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}
{"type": "object", "properties": {"id": {"type": "integer", "description": "Contact ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false, "description": "Contact"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/d009741c-eb05-4361-ba69-b1e72c5bde7a/0/0
Altoviz
Invoicing and accounting APIs
null
GET_Contacts_List
200
null
[{"id": 0, "title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}]
{"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "description": "Contact ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false, "description": "Contact"}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/ab1a320e-87c8-4596-b420-a18227b88103/0/0
Altoviz
Invoicing and accounting APIs
null
GET_Webhooks_List
200
null
[{"id": 0, "name": "", "secretKey": "", "url": "", "types": ["CustomerCreated"]}]
{"type": "array", "items": {"required": ["name", "types", "url"], "type": "object", "properties": {"id": {"type": "integer", "description": "Webhook ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"minLength": 1, "type": "string", "description": "Name"}, "secretKey": {"type": ["string", "null"], "description": "Secret key"}, "url": {"minLength": 1, "type": "string", "description": "Webhook Uri"}, "types": {"type": "array", "items": {"enum": ["CustomerCreated", "InvoiceCreated", "CustomerDeleted", "CustomerUpdated", "ProductCreated", "ProductUpdated", "ProductDeleted", "InvoiceUpdated"], "type": "string"}, "description": ""}}, "additionalProperties": false, "description": "Wehbook"}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/f434abda-d1c6-461d-8361-467ead188fff/0/0
Altoviz
Invoicing and accounting APIs
null
POST_Contacts_Post
400
null
{"message": "", "errors": []}
{"type": "object", "properties": {"message": {"type": ["string", "null"], "description": "Error message"}, "errors": {"type": ["array", "null"], "items": {"type": "string"}, "description": "List of error messages"}}, "additionalProperties": false, "description": "Error"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/f434abda-d1c6-461d-8361-467ead188fff/1/0
Altoviz
Invoicing and accounting APIs
null
POST_Contacts_Post
200
null
{"id": 0, "title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}
{"type": "object", "properties": {"id": {"type": "integer", "description": "Contact ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false, "description": "Contact"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/62a9106e-b2c7-472b-8756-609c4ab91841/0/0
Altoviz
Invoicing and accounting APIs
null
POST_Webhooks_Post
400
null
{"message": "", "errors": []}
{"type": "object", "properties": {"message": {"type": ["string", "null"], "description": "Error message"}, "errors": {"type": ["array", "null"], "items": {"type": "string"}, "description": "List of error messages"}}, "additionalProperties": false, "description": "Error"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/62a9106e-b2c7-472b-8756-609c4ab91841/1/0
Altoviz
Invoicing and accounting APIs
null
POST_Webhooks_Post
200
null
{"id": 0, "name": "", "secretKey": "", "url": "", "types": ["CustomerCreated"]}
{"required": ["name", "types", "url"], "type": "object", "properties": {"id": {"type": "integer", "description": "Webhook ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"minLength": 1, "type": "string", "description": "Name"}, "secretKey": {"type": ["string", "null"], "description": "Secret key"}, "url": {"minLength": 1, "type": "string", "description": "Webhook Uri"}, "types": {"type": "array", "items": {"enum": ["CustomerCreated", "InvoiceCreated", "CustomerDeleted", "CustomerUpdated", "ProductCreated", "ProductUpdated", "ProductDeleted", "InvoiceUpdated"], "type": "string"}, "description": ""}}, "additionalProperties": false, "description": "Wehbook"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/63ef6c81-8675-4873-bf94-096ca52ea497/0/0
Altoviz
Invoicing and accounting APIs
null
GET_Contacts_Find
200
null
[{"id": 0, "title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}]
{"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "description": "Contact ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false, "description": "Contact"}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/c2ae63fd-2cd5-4720-9440-a854d1e12b95/0/0
Altoviz
Invoicing and accounting APIs
null
GET_Users_GetMe
404
null
{"type": "", "title": "", "status": 0, "detail": "", "instance": ""}
{"type": "object", "properties": {"type": {"type": ["string", "null"]}, "title": {"type": ["string", "null"]}, "status": {"type": ["integer", "null"], "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "detail": {"type": ["string", "null"]}, "instance": {"type": ["string", "null"]}}, "additionalProperties": {}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/c2ae63fd-2cd5-4720-9440-a854d1e12b95/1/0
Altoviz
Invoicing and accounting APIs
null
GET_Users_GetMe
200
null
{"userId": "", "lastName": "", "firstName": "", "displayName": "", "phone": "", "email": "", "status": "Inactive", "profile": "Owner"}
{"type": "object", "properties": {"userId": {"type": ["string", "null"], "description": "User Id"}, "lastName": {"type": ["string", "null"], "description": "Last name"}, "firstName": {"type": ["string", "null"], "description": "First name"}, "displayName": {"type": ["string", "null"], "description": "Display name"}, "phone": {"type": ["string", "null"], "description": "Phone"}, "email": {"type": ["string", "null"], "description": "E-mail"}, "status": {"enum": ["Inactive", "InvitationSent", "Active", "Unknown"], "type": "string"}, "profile": {"enum": ["Owner", "Standard", "Accountant", "Support", "Api", "Unknown"], "type": "string"}}, "additionalProperties": false, "description": "User"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/e69f90a1-13ab-4be1-8585-b663db3f55bd/0/0
Altoviz
Invoicing and accounting APIs
null
GET_Users_GetMe
200
null
{"userId": "", "lastName": "", "firstName": "", "displayName": "", "phone": "", "email": "", "status": "Inactive", "profile": "Owner"}
{"type": "object", "properties": {"userId": {"type": ["string", "null"], "description": "User Id"}, "lastName": {"type": ["string", "null"], "description": "Last name"}, "firstName": {"type": ["string", "null"], "description": "First name"}, "displayName": {"type": ["string", "null"], "description": "Display name"}, "phone": {"type": ["string", "null"], "description": "Phone"}, "email": {"type": ["string", "null"], "description": "E-mail"}, "status": {"enum": ["Inactive", "InvitationSent", "Active", "Unknown"], "type": "string"}, "profile": {"enum": ["Owner", "Standard", "Accountant", "Support", "Api", "Unknown"], "type": "string"}}, "additionalProperties": false, "description": "User"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/e69f90a1-13ab-4be1-8585-b663db3f55bd/1/0
Altoviz
Invoicing and accounting APIs
null
GET_Users_GetMe
404
null
{"type": "", "title": "", "status": 0, "detail": "", "instance": ""}
{"type": "object", "properties": {"type": {"type": ["string", "null"]}, "title": {"type": ["string", "null"]}, "status": {"type": ["integer", "null"], "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "detail": {"type": ["string", "null"]}, "instance": {"type": ["string", "null"]}}, "additionalProperties": {}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/246aaef9-cd83-4113-b7ad-4277fcb2ffe4/0/0
Altoviz
Invoicing and accounting APIs
null
GET_SaleInvoices_Get
200
null
{"vatMode": "Auto", "isDraft": true, "isPaid": true, "isProforma": true, "isCancelled": true, "replacedBy": 0, "id": 0, "number": "", "date": "", "customerId": 0, "customerNumber": "", "customerName": "", "customerVatNumber": "", "customerOrderReference": "", "billingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "subject": "", "useTaxIncludedPrices": true, "vatReverseCharge": true, "lines": [{"id": 0, "description": "", "taxExcludedPrice": 0, "taxIncludedPrice": 0, "quantity": 0, "classificationId": 0, "taxExcludedAmount": 0, "taxIncludedAmount": 0, "vatId": 0, "discount": {"type": "Percent", "value": 0}, "date": "", "type": "Empty", "productId": 0, "productNumber": "", "purchasePrice": 0, "marginRate": 0, "marginAmount": 0, "disbursement": true, "product": {"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}], "grossTaxExcludedAmount": 0, "globalDiscount": {"type": "Percent", "value": 0}, "taxExcludedAmount": 0, "shippingAmount": 0, "shippingVatId": 0, "taxAmount": 0, "dueAmount": 0, "taxIncludedAmount": 0, "notes": "", "vendorReference": "", "pdfUrl": ""}
{"required": ["customerId"], "type": "object", "properties": {"vatMode": {"enum": ["Auto", "Debit", "Collection"], "type": "string"}, "isDraft": {"type": "boolean", "description": "Indicates whether invoice is draft. Otherwise invoice cannot be modified"}, "isPaid": {"type": "boolean", "description": "Indicates whether invoice is paid"}, "isProforma": {"type": "boolean", "description": "Indicates whether invoice is proforma"}, "isCancelled": {"type": "boolean", "description": "Indicates whether invoice is cancelled"}, "replacedBy": {"type": ["integer", "null"], "description": "Replacement invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "id": {"type": ["integer", "null"], "description": "Invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "number": {"type": ["string", "null"], "description": "Number"}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "customerId": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "customerNumber": {"type": ["string", "null"], "description": "Customer number"}, "customerName": {"type": ["string", "null"], "description": "Customer name"}, "customerVatNumber": {"type": ["string", "null"], "description": "Customer VAT number"}, "customerOrderReference": {"type": ["string", "null"], "description": "Customer order reference"}, "billingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "subject": {"type": ["string", "null"], "description": "Subject"}, "useTaxIncludedPrices": {"type": "boolean", "description": "Indicates whether invoice prices and amount are tax included"}, "vatReverseCharge": {"type": "boolean", "description": "VAT reverse charge"}, "lines": {"type": ["array", "null"], "items": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Invoice line ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "description": {"type": ["string", "null"], "description": "Description (can be html)"}, "taxExcludedPrice": {"type": ["number", "null"], "description": "Tax excluded price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedPrice": {"type": ["number", "null"], "description": "Tax included price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "quantity": {"type": ["number", "null"], "description": "Quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "classificationId": {"type": ["integer", "null"], "description": "Classification ID (should be defined if line is product or service)", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxExcludedAmount": {"type": ["number", "null"], "description": "Tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": ["number", "null"], "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "type": {"enum": ["Empty", "Product", "Service", "Subtotal", "Text", "Deposit", "NewPage", "Title"], "type": "string"}, "productId": {"type": ["integer", "null"], "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "productNumber": {"type": ["string", "null"], "description": "Product number"}, "purchasePrice": {"type": ["number", "null"], "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginRate": {"type": "number", "description": "Margin rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginAmount": {"type": "number", "description": "Margin amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "disbursement": {"type": "boolean", "description": "Disbursement"}, "product": {"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Invoice line"}, "description": "Invoice lines"}, "grossTaxExcludedAmount": {"type": "number", "description": "Gross tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "globalDiscount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "taxExcludedAmount": {"type": "number", "description": "Tax excluded amount (discount included)", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingAmount": {"type": "number", "description": "Shipping amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingVatId": {"type": ["integer", "null"], "description": "Shipping VAT ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxAmount": {"type": "number", "description": "Total tax amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "dueAmount": {"type": "number", "description": "Total due", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": "number", "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "notes": {"type": ["string", "null"], "description": "Notes to be print"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference to be print"}, "pdfUrl": {"type": ["string", "null"], "description": "Pdf url"}}, "additionalProperties": false, "description": "Invoice"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/246aaef9-cd83-4113-b7ad-4277fcb2ffe4/1/0
Altoviz
Invoicing and accounting APIs
null
GET_SaleInvoices_Get
200
null
{"vatMode": "Auto", "isDraft": true, "isPaid": true, "isProforma": true, "isCancelled": true, "replacedBy": 0, "id": 0, "number": "", "date": "", "customerId": 0, "customerNumber": "", "customerName": "", "customerVatNumber": "", "customerOrderReference": "", "billingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "subject": "", "useTaxIncludedPrices": true, "vatReverseCharge": true, "lines": [{"id": 0, "description": "", "taxExcludedPrice": 0, "taxIncludedPrice": 0, "quantity": 0, "classificationId": 0, "taxExcludedAmount": 0, "taxIncludedAmount": 0, "vatId": 0, "discount": {"type": "Percent", "value": 0}, "date": "", "type": "Empty", "productId": 0, "productNumber": "", "purchasePrice": 0, "marginRate": 0, "marginAmount": 0, "disbursement": true, "product": {"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}], "grossTaxExcludedAmount": 0, "globalDiscount": {"type": "Percent", "value": 0}, "taxExcludedAmount": 0, "shippingAmount": 0, "shippingVatId": 0, "taxAmount": 0, "dueAmount": 0, "taxIncludedAmount": 0, "notes": "", "vendorReference": "", "pdfUrl": ""}
{"required": ["customerId"], "type": "object", "properties": {"vatMode": {"enum": ["Auto", "Debit", "Collection"], "type": "string"}, "isDraft": {"type": "boolean", "description": "Indicates whether invoice is draft. Otherwise invoice cannot be modified"}, "isPaid": {"type": "boolean", "description": "Indicates whether invoice is paid"}, "isProforma": {"type": "boolean", "description": "Indicates whether invoice is proforma"}, "isCancelled": {"type": "boolean", "description": "Indicates whether invoice is cancelled"}, "replacedBy": {"type": ["integer", "null"], "description": "Replacement invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "id": {"type": ["integer", "null"], "description": "Invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "number": {"type": ["string", "null"], "description": "Number"}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "customerId": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "customerNumber": {"type": ["string", "null"], "description": "Customer number"}, "customerName": {"type": ["string", "null"], "description": "Customer name"}, "customerVatNumber": {"type": ["string", "null"], "description": "Customer VAT number"}, "customerOrderReference": {"type": ["string", "null"], "description": "Customer order reference"}, "billingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "subject": {"type": ["string", "null"], "description": "Subject"}, "useTaxIncludedPrices": {"type": "boolean", "description": "Indicates whether invoice prices and amount are tax included"}, "vatReverseCharge": {"type": "boolean", "description": "VAT reverse charge"}, "lines": {"type": ["array", "null"], "items": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Invoice line ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "description": {"type": ["string", "null"], "description": "Description (can be html)"}, "taxExcludedPrice": {"type": ["number", "null"], "description": "Tax excluded price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedPrice": {"type": ["number", "null"], "description": "Tax included price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "quantity": {"type": ["number", "null"], "description": "Quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "classificationId": {"type": ["integer", "null"], "description": "Classification ID (should be defined if line is product or service)", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxExcludedAmount": {"type": ["number", "null"], "description": "Tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": ["number", "null"], "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "type": {"enum": ["Empty", "Product", "Service", "Subtotal", "Text", "Deposit", "NewPage", "Title"], "type": "string"}, "productId": {"type": ["integer", "null"], "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "productNumber": {"type": ["string", "null"], "description": "Product number"}, "purchasePrice": {"type": ["number", "null"], "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginRate": {"type": "number", "description": "Margin rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginAmount": {"type": "number", "description": "Margin amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "disbursement": {"type": "boolean", "description": "Disbursement"}, "product": {"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Invoice line"}, "description": "Invoice lines"}, "grossTaxExcludedAmount": {"type": "number", "description": "Gross tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "globalDiscount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "taxExcludedAmount": {"type": "number", "description": "Tax excluded amount (discount included)", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingAmount": {"type": "number", "description": "Shipping amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingVatId": {"type": ["integer", "null"], "description": "Shipping VAT ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxAmount": {"type": "number", "description": "Total tax amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "dueAmount": {"type": "number", "description": "Total due", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": "number", "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "notes": {"type": ["string", "null"], "description": "Notes to be print"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference to be print"}, "pdfUrl": {"type": ["string", "null"], "description": "Pdf url"}}, "additionalProperties": false, "description": "Invoice"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/d6d2c9fd-020e-4e2d-a636-72bdb0bdd7de/0/0
Altoviz
Invoicing and accounting APIs
null
GET_SaleInvoices_List
200
null
[{"vatMode": "Auto", "isDraft": true, "isPaid": true, "isProforma": true, "isCancelled": true, "replacedBy": 0, "id": 0, "number": "", "date": "", "customerId": 0, "customerNumber": "", "customerName": "", "customerVatNumber": "", "customerOrderReference": "", "billingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "subject": "", "useTaxIncludedPrices": true, "vatReverseCharge": true, "lines": [{"id": 0, "description": "", "taxExcludedPrice": 0, "taxIncludedPrice": 0, "quantity": 0, "classificationId": 0, "taxExcludedAmount": 0, "taxIncludedAmount": 0, "vatId": 0, "discount": {"type": "Percent", "value": 0}, "date": "", "type": "Empty", "productId": 0, "productNumber": "", "purchasePrice": 0, "marginRate": 0, "marginAmount": 0, "disbursement": true, "product": {"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}], "grossTaxExcludedAmount": 0, "globalDiscount": {"type": "Percent", "value": 0}, "taxExcludedAmount": 0, "shippingAmount": 0, "shippingVatId": 0, "taxAmount": 0, "dueAmount": 0, "taxIncludedAmount": 0, "notes": "", "vendorReference": "", "pdfUrl": ""}]
{"type": "array", "items": {"required": ["customerId"], "type": "object", "properties": {"vatMode": {"enum": ["Auto", "Debit", "Collection"], "type": "string"}, "isDraft": {"type": "boolean", "description": "Indicates whether invoice is draft. Otherwise invoice cannot be modified"}, "isPaid": {"type": "boolean", "description": "Indicates whether invoice is paid"}, "isProforma": {"type": "boolean", "description": "Indicates whether invoice is proforma"}, "isCancelled": {"type": "boolean", "description": "Indicates whether invoice is cancelled"}, "replacedBy": {"type": ["integer", "null"], "description": "Replacement invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "id": {"type": ["integer", "null"], "description": "Invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "number": {"type": ["string", "null"], "description": "Number"}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "customerId": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "customerNumber": {"type": ["string", "null"], "description": "Customer number"}, "customerName": {"type": ["string", "null"], "description": "Customer name"}, "customerVatNumber": {"type": ["string", "null"], "description": "Customer VAT number"}, "customerOrderReference": {"type": ["string", "null"], "description": "Customer order reference"}, "billingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "subject": {"type": ["string", "null"], "description": "Subject"}, "useTaxIncludedPrices": {"type": "boolean", "description": "Indicates whether invoice prices and amount are tax included"}, "vatReverseCharge": {"type": "boolean", "description": "VAT reverse charge"}, "lines": {"type": ["array", "null"], "items": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Invoice line ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "description": {"type": ["string", "null"], "description": "Description (can be html)"}, "taxExcludedPrice": {"type": ["number", "null"], "description": "Tax excluded price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedPrice": {"type": ["number", "null"], "description": "Tax included price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "quantity": {"type": ["number", "null"], "description": "Quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "classificationId": {"type": ["integer", "null"], "description": "Classification ID (should be defined if line is product or service)", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxExcludedAmount": {"type": ["number", "null"], "description": "Tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": ["number", "null"], "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "type": {"enum": ["Empty", "Product", "Service", "Subtotal", "Text", "Deposit", "NewPage", "Title"], "type": "string"}, "productId": {"type": ["integer", "null"], "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "productNumber": {"type": ["string", "null"], "description": "Product number"}, "purchasePrice": {"type": ["number", "null"], "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginRate": {"type": "number", "description": "Margin rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginAmount": {"type": "number", "description": "Margin amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "disbursement": {"type": "boolean", "description": "Disbursement"}, "product": {"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Invoice line"}, "description": "Invoice lines"}, "grossTaxExcludedAmount": {"type": "number", "description": "Gross tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "globalDiscount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "taxExcludedAmount": {"type": "number", "description": "Tax excluded amount (discount included)", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingAmount": {"type": "number", "description": "Shipping amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingVatId": {"type": ["integer", "null"], "description": "Shipping VAT ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxAmount": {"type": "number", "description": "Total tax amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "dueAmount": {"type": "number", "description": "Total due", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": "number", "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "notes": {"type": ["string", "null"], "description": "Notes to be print"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference to be print"}, "pdfUrl": {"type": ["string", "null"], "description": "Pdf url"}}, "additionalProperties": false, "description": "Invoice"}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/d6d2c9fd-020e-4e2d-a636-72bdb0bdd7de/1/0
Altoviz
Invoicing and accounting APIs
null
GET_SaleInvoices_List
200
null
[{"vatMode": "Auto", "isDraft": true, "isPaid": true, "isProforma": true, "isCancelled": true, "replacedBy": 0, "id": 0, "number": "", "date": "", "customerId": 0, "customerNumber": "", "customerName": "", "customerVatNumber": "", "customerOrderReference": "", "billingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "subject": "", "useTaxIncludedPrices": true, "vatReverseCharge": true, "lines": [{"id": 0, "description": "", "taxExcludedPrice": 0, "taxIncludedPrice": 0, "quantity": 0, "classificationId": 0, "taxExcludedAmount": 0, "taxIncludedAmount": 0, "vatId": 0, "discount": {"type": "Percent", "value": 0}, "date": "", "type": "Empty", "productId": 0, "productNumber": "", "purchasePrice": 0, "marginRate": 0, "marginAmount": 0, "disbursement": true, "product": {"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}], "grossTaxExcludedAmount": 0, "globalDiscount": {"type": "Percent", "value": 0}, "taxExcludedAmount": 0, "shippingAmount": 0, "shippingVatId": 0, "taxAmount": 0, "dueAmount": 0, "taxIncludedAmount": 0, "notes": "", "vendorReference": "", "pdfUrl": ""}]
{"type": "array", "items": {"required": ["customerId"], "type": "object", "properties": {"vatMode": {"enum": ["Auto", "Debit", "Collection"], "type": "string"}, "isDraft": {"type": "boolean", "description": "Indicates whether invoice is draft. Otherwise invoice cannot be modified"}, "isPaid": {"type": "boolean", "description": "Indicates whether invoice is paid"}, "isProforma": {"type": "boolean", "description": "Indicates whether invoice is proforma"}, "isCancelled": {"type": "boolean", "description": "Indicates whether invoice is cancelled"}, "replacedBy": {"type": ["integer", "null"], "description": "Replacement invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "id": {"type": ["integer", "null"], "description": "Invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "number": {"type": ["string", "null"], "description": "Number"}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "customerId": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "customerNumber": {"type": ["string", "null"], "description": "Customer number"}, "customerName": {"type": ["string", "null"], "description": "Customer name"}, "customerVatNumber": {"type": ["string", "null"], "description": "Customer VAT number"}, "customerOrderReference": {"type": ["string", "null"], "description": "Customer order reference"}, "billingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "subject": {"type": ["string", "null"], "description": "Subject"}, "useTaxIncludedPrices": {"type": "boolean", "description": "Indicates whether invoice prices and amount are tax included"}, "vatReverseCharge": {"type": "boolean", "description": "VAT reverse charge"}, "lines": {"type": ["array", "null"], "items": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Invoice line ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "description": {"type": ["string", "null"], "description": "Description (can be html)"}, "taxExcludedPrice": {"type": ["number", "null"], "description": "Tax excluded price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedPrice": {"type": ["number", "null"], "description": "Tax included price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "quantity": {"type": ["number", "null"], "description": "Quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "classificationId": {"type": ["integer", "null"], "description": "Classification ID (should be defined if line is product or service)", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxExcludedAmount": {"type": ["number", "null"], "description": "Tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": ["number", "null"], "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "type": {"enum": ["Empty", "Product", "Service", "Subtotal", "Text", "Deposit", "NewPage", "Title"], "type": "string"}, "productId": {"type": ["integer", "null"], "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "productNumber": {"type": ["string", "null"], "description": "Product number"}, "purchasePrice": {"type": ["number", "null"], "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginRate": {"type": "number", "description": "Margin rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginAmount": {"type": "number", "description": "Margin amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "disbursement": {"type": "boolean", "description": "Disbursement"}, "product": {"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Invoice line"}, "description": "Invoice lines"}, "grossTaxExcludedAmount": {"type": "number", "description": "Gross tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "globalDiscount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "taxExcludedAmount": {"type": "number", "description": "Tax excluded amount (discount included)", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingAmount": {"type": "number", "description": "Shipping amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingVatId": {"type": ["integer", "null"], "description": "Shipping VAT ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxAmount": {"type": "number", "description": "Total tax amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "dueAmount": {"type": "number", "description": "Total due", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": "number", "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "notes": {"type": ["string", "null"], "description": "Notes to be print"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference to be print"}, "pdfUrl": {"type": ["string", "null"], "description": "Pdf url"}}, "additionalProperties": false, "description": "Invoice"}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/5b32026d-2c18-4e36-9d80-3ce0278f6d64/0/0
Altoviz
Invoicing and accounting APIs
null
POST_SaleInvoices_Finalize
200
null
{"vatMode": "Auto", "isDraft": true, "isPaid": true, "isProforma": true, "isCancelled": true, "replacedBy": 0, "id": 0, "number": "", "date": "", "customerId": 0, "customerNumber": "", "customerName": "", "customerVatNumber": "", "customerOrderReference": "", "billingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "subject": "", "useTaxIncludedPrices": true, "vatReverseCharge": true, "lines": [{"id": 0, "description": "", "taxExcludedPrice": 0, "taxIncludedPrice": 0, "quantity": 0, "classificationId": 0, "taxExcludedAmount": 0, "taxIncludedAmount": 0, "vatId": 0, "discount": {"type": "Percent", "value": 0}, "date": "", "type": "Empty", "productId": 0, "productNumber": "", "purchasePrice": 0, "marginRate": 0, "marginAmount": 0, "disbursement": true, "product": {"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}], "grossTaxExcludedAmount": 0, "globalDiscount": {"type": "Percent", "value": 0}, "taxExcludedAmount": 0, "shippingAmount": 0, "shippingVatId": 0, "taxAmount": 0, "dueAmount": 0, "taxIncludedAmount": 0, "notes": "", "vendorReference": "", "pdfUrl": ""}
{"required": ["customerId"], "type": "object", "properties": {"vatMode": {"enum": ["Auto", "Debit", "Collection"], "type": "string"}, "isDraft": {"type": "boolean", "description": "Indicates whether invoice is draft. Otherwise invoice cannot be modified"}, "isPaid": {"type": "boolean", "description": "Indicates whether invoice is paid"}, "isProforma": {"type": "boolean", "description": "Indicates whether invoice is proforma"}, "isCancelled": {"type": "boolean", "description": "Indicates whether invoice is cancelled"}, "replacedBy": {"type": ["integer", "null"], "description": "Replacement invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "id": {"type": ["integer", "null"], "description": "Invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "number": {"type": ["string", "null"], "description": "Number"}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "customerId": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "customerNumber": {"type": ["string", "null"], "description": "Customer number"}, "customerName": {"type": ["string", "null"], "description": "Customer name"}, "customerVatNumber": {"type": ["string", "null"], "description": "Customer VAT number"}, "customerOrderReference": {"type": ["string", "null"], "description": "Customer order reference"}, "billingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "subject": {"type": ["string", "null"], "description": "Subject"}, "useTaxIncludedPrices": {"type": "boolean", "description": "Indicates whether invoice prices and amount are tax included"}, "vatReverseCharge": {"type": "boolean", "description": "VAT reverse charge"}, "lines": {"type": ["array", "null"], "items": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Invoice line ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "description": {"type": ["string", "null"], "description": "Description (can be html)"}, "taxExcludedPrice": {"type": ["number", "null"], "description": "Tax excluded price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedPrice": {"type": ["number", "null"], "description": "Tax included price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "quantity": {"type": ["number", "null"], "description": "Quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "classificationId": {"type": ["integer", "null"], "description": "Classification ID (should be defined if line is product or service)", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxExcludedAmount": {"type": ["number", "null"], "description": "Tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": ["number", "null"], "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "type": {"enum": ["Empty", "Product", "Service", "Subtotal", "Text", "Deposit", "NewPage", "Title"], "type": "string"}, "productId": {"type": ["integer", "null"], "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "productNumber": {"type": ["string", "null"], "description": "Product number"}, "purchasePrice": {"type": ["number", "null"], "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginRate": {"type": "number", "description": "Margin rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginAmount": {"type": "number", "description": "Margin amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "disbursement": {"type": "boolean", "description": "Disbursement"}, "product": {"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Invoice line"}, "description": "Invoice lines"}, "grossTaxExcludedAmount": {"type": "number", "description": "Gross tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "globalDiscount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "taxExcludedAmount": {"type": "number", "description": "Tax excluded amount (discount included)", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingAmount": {"type": "number", "description": "Shipping amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingVatId": {"type": ["integer", "null"], "description": "Shipping VAT ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxAmount": {"type": "number", "description": "Total tax amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "dueAmount": {"type": "number", "description": "Total due", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": "number", "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "notes": {"type": ["string", "null"], "description": "Notes to be print"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference to be print"}, "pdfUrl": {"type": ["string", "null"], "description": "Pdf url"}}, "additionalProperties": false, "description": "Invoice"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/5b32026d-2c18-4e36-9d80-3ce0278f6d64/1/0
Altoviz
Invoicing and accounting APIs
null
POST_SaleInvoices_Finalize
200
null
{"vatMode": "Auto", "isDraft": true, "isPaid": true, "isProforma": true, "isCancelled": true, "replacedBy": 0, "id": 0, "number": "", "date": "", "customerId": 0, "customerNumber": "", "customerName": "", "customerVatNumber": "", "customerOrderReference": "", "billingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "subject": "", "useTaxIncludedPrices": true, "vatReverseCharge": true, "lines": [{"id": 0, "description": "", "taxExcludedPrice": 0, "taxIncludedPrice": 0, "quantity": 0, "classificationId": 0, "taxExcludedAmount": 0, "taxIncludedAmount": 0, "vatId": 0, "discount": {"type": "Percent", "value": 0}, "date": "", "type": "Empty", "productId": 0, "productNumber": "", "purchasePrice": 0, "marginRate": 0, "marginAmount": 0, "disbursement": true, "product": {"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}], "grossTaxExcludedAmount": 0, "globalDiscount": {"type": "Percent", "value": 0}, "taxExcludedAmount": 0, "shippingAmount": 0, "shippingVatId": 0, "taxAmount": 0, "dueAmount": 0, "taxIncludedAmount": 0, "notes": "", "vendorReference": "", "pdfUrl": ""}
{"required": ["customerId"], "type": "object", "properties": {"vatMode": {"enum": ["Auto", "Debit", "Collection"], "type": "string"}, "isDraft": {"type": "boolean", "description": "Indicates whether invoice is draft. Otherwise invoice cannot be modified"}, "isPaid": {"type": "boolean", "description": "Indicates whether invoice is paid"}, "isProforma": {"type": "boolean", "description": "Indicates whether invoice is proforma"}, "isCancelled": {"type": "boolean", "description": "Indicates whether invoice is cancelled"}, "replacedBy": {"type": ["integer", "null"], "description": "Replacement invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "id": {"type": ["integer", "null"], "description": "Invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "number": {"type": ["string", "null"], "description": "Number"}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "customerId": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "customerNumber": {"type": ["string", "null"], "description": "Customer number"}, "customerName": {"type": ["string", "null"], "description": "Customer name"}, "customerVatNumber": {"type": ["string", "null"], "description": "Customer VAT number"}, "customerOrderReference": {"type": ["string", "null"], "description": "Customer order reference"}, "billingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "subject": {"type": ["string", "null"], "description": "Subject"}, "useTaxIncludedPrices": {"type": "boolean", "description": "Indicates whether invoice prices and amount are tax included"}, "vatReverseCharge": {"type": "boolean", "description": "VAT reverse charge"}, "lines": {"type": ["array", "null"], "items": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Invoice line ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "description": {"type": ["string", "null"], "description": "Description (can be html)"}, "taxExcludedPrice": {"type": ["number", "null"], "description": "Tax excluded price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedPrice": {"type": ["number", "null"], "description": "Tax included price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "quantity": {"type": ["number", "null"], "description": "Quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "classificationId": {"type": ["integer", "null"], "description": "Classification ID (should be defined if line is product or service)", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxExcludedAmount": {"type": ["number", "null"], "description": "Tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": ["number", "null"], "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "type": {"enum": ["Empty", "Product", "Service", "Subtotal", "Text", "Deposit", "NewPage", "Title"], "type": "string"}, "productId": {"type": ["integer", "null"], "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "productNumber": {"type": ["string", "null"], "description": "Product number"}, "purchasePrice": {"type": ["number", "null"], "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginRate": {"type": "number", "description": "Margin rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginAmount": {"type": "number", "description": "Margin amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "disbursement": {"type": "boolean", "description": "Disbursement"}, "product": {"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Invoice line"}, "description": "Invoice lines"}, "grossTaxExcludedAmount": {"type": "number", "description": "Gross tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "globalDiscount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "taxExcludedAmount": {"type": "number", "description": "Tax excluded amount (discount included)", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingAmount": {"type": "number", "description": "Shipping amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingVatId": {"type": ["integer", "null"], "description": "Shipping VAT ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxAmount": {"type": "number", "description": "Total tax amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "dueAmount": {"type": "number", "description": "Total due", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": "number", "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "notes": {"type": ["string", "null"], "description": "Notes to be print"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference to be print"}, "pdfUrl": {"type": ["string", "null"], "description": "Pdf url"}}, "additionalProperties": false, "description": "Invoice"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/c758ae80-03a9-44c9-9804-11b47edc3c6c/0/0
Altoviz
Invoicing and accounting APIs
null
POST_SaleInvoices_Post
200
null
{"vatMode": "Auto", "isDraft": true, "isPaid": true, "isProforma": true, "isCancelled": true, "replacedBy": 0, "id": 0, "number": "", "date": "", "customerId": 0, "customerNumber": "", "customerName": "", "customerVatNumber": "", "customerOrderReference": "", "billingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "subject": "", "useTaxIncludedPrices": true, "vatReverseCharge": true, "lines": [{"id": 0, "description": "", "taxExcludedPrice": 0, "taxIncludedPrice": 0, "quantity": 0, "classificationId": 0, "taxExcludedAmount": 0, "taxIncludedAmount": 0, "vatId": 0, "discount": {"type": "Percent", "value": 0}, "date": "", "type": "Empty", "productId": 0, "productNumber": "", "purchasePrice": 0, "marginRate": 0, "marginAmount": 0, "disbursement": true, "product": {"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}], "grossTaxExcludedAmount": 0, "globalDiscount": {"type": "Percent", "value": 0}, "taxExcludedAmount": 0, "shippingAmount": 0, "shippingVatId": 0, "taxAmount": 0, "dueAmount": 0, "taxIncludedAmount": 0, "notes": "", "vendorReference": "", "pdfUrl": ""}
{"required": ["customerId"], "type": "object", "properties": {"vatMode": {"enum": ["Auto", "Debit", "Collection"], "type": "string"}, "isDraft": {"type": "boolean", "description": "Indicates whether invoice is draft. Otherwise invoice cannot be modified"}, "isPaid": {"type": "boolean", "description": "Indicates whether invoice is paid"}, "isProforma": {"type": "boolean", "description": "Indicates whether invoice is proforma"}, "isCancelled": {"type": "boolean", "description": "Indicates whether invoice is cancelled"}, "replacedBy": {"type": ["integer", "null"], "description": "Replacement invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "id": {"type": ["integer", "null"], "description": "Invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "number": {"type": ["string", "null"], "description": "Number"}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "customerId": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "customerNumber": {"type": ["string", "null"], "description": "Customer number"}, "customerName": {"type": ["string", "null"], "description": "Customer name"}, "customerVatNumber": {"type": ["string", "null"], "description": "Customer VAT number"}, "customerOrderReference": {"type": ["string", "null"], "description": "Customer order reference"}, "billingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "subject": {"type": ["string", "null"], "description": "Subject"}, "useTaxIncludedPrices": {"type": "boolean", "description": "Indicates whether invoice prices and amount are tax included"}, "vatReverseCharge": {"type": "boolean", "description": "VAT reverse charge"}, "lines": {"type": ["array", "null"], "items": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Invoice line ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "description": {"type": ["string", "null"], "description": "Description (can be html)"}, "taxExcludedPrice": {"type": ["number", "null"], "description": "Tax excluded price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedPrice": {"type": ["number", "null"], "description": "Tax included price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "quantity": {"type": ["number", "null"], "description": "Quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "classificationId": {"type": ["integer", "null"], "description": "Classification ID (should be defined if line is product or service)", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxExcludedAmount": {"type": ["number", "null"], "description": "Tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": ["number", "null"], "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "type": {"enum": ["Empty", "Product", "Service", "Subtotal", "Text", "Deposit", "NewPage", "Title"], "type": "string"}, "productId": {"type": ["integer", "null"], "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "productNumber": {"type": ["string", "null"], "description": "Product number"}, "purchasePrice": {"type": ["number", "null"], "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginRate": {"type": "number", "description": "Margin rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginAmount": {"type": "number", "description": "Margin amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "disbursement": {"type": "boolean", "description": "Disbursement"}, "product": {"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Invoice line"}, "description": "Invoice lines"}, "grossTaxExcludedAmount": {"type": "number", "description": "Gross tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "globalDiscount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "taxExcludedAmount": {"type": "number", "description": "Tax excluded amount (discount included)", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingAmount": {"type": "number", "description": "Shipping amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingVatId": {"type": ["integer", "null"], "description": "Shipping VAT ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxAmount": {"type": "number", "description": "Total tax amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "dueAmount": {"type": "number", "description": "Total due", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": "number", "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "notes": {"type": ["string", "null"], "description": "Notes to be print"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference to be print"}, "pdfUrl": {"type": ["string", "null"], "description": "Pdf url"}}, "additionalProperties": false, "description": "Invoice"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/c758ae80-03a9-44c9-9804-11b47edc3c6c/1/0
Altoviz
Invoicing and accounting APIs
null
POST_SaleInvoices_Post
200
null
{"vatMode": "Auto", "isDraft": true, "isPaid": true, "isProforma": true, "isCancelled": true, "replacedBy": 0, "id": 0, "number": "", "date": "", "customerId": 0, "customerNumber": "", "customerName": "", "customerVatNumber": "", "customerOrderReference": "", "billingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingContact": {"title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "subject": "", "useTaxIncludedPrices": true, "vatReverseCharge": true, "lines": [{"id": 0, "description": "", "taxExcludedPrice": 0, "taxIncludedPrice": 0, "quantity": 0, "classificationId": 0, "taxExcludedAmount": 0, "taxIncludedAmount": 0, "vatId": 0, "discount": {"type": "Percent", "value": 0}, "date": "", "type": "Empty", "productId": 0, "productNumber": "", "purchasePrice": 0, "marginRate": 0, "marginAmount": 0, "disbursement": true, "product": {"id": 0, "name": "", "number": "", "classificationId": 0, "salePrice": 0, "isSalePriceTaxIncluded": true, "purchasePrice": 0, "salesDefaultQuantity": 0, "description": "", "vatId": 0, "salesUnitId": 0, "availableForSales": true, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}, "vat": {"id": 0, "rate": 0, "region": "FR", "label": ""}}], "grossTaxExcludedAmount": 0, "globalDiscount": {"type": "Percent", "value": 0}, "taxExcludedAmount": 0, "shippingAmount": 0, "shippingVatId": 0, "taxAmount": 0, "dueAmount": 0, "taxIncludedAmount": 0, "notes": "", "vendorReference": "", "pdfUrl": ""}
{"required": ["customerId"], "type": "object", "properties": {"vatMode": {"enum": ["Auto", "Debit", "Collection"], "type": "string"}, "isDraft": {"type": "boolean", "description": "Indicates whether invoice is draft. Otherwise invoice cannot be modified"}, "isPaid": {"type": "boolean", "description": "Indicates whether invoice is paid"}, "isProforma": {"type": "boolean", "description": "Indicates whether invoice is proforma"}, "isCancelled": {"type": "boolean", "description": "Indicates whether invoice is cancelled"}, "replacedBy": {"type": ["integer", "null"], "description": "Replacement invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "id": {"type": ["integer", "null"], "description": "Invoice ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "number": {"type": ["string", "null"], "description": "Number"}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "customerId": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "customerNumber": {"type": ["string", "null"], "description": "Customer number"}, "customerName": {"type": ["string", "null"], "description": "Customer name"}, "customerVatNumber": {"type": ["string", "null"], "description": "Customer VAT number"}, "customerOrderReference": {"type": ["string", "null"], "description": "Customer order reference"}, "billingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingContact": {"type": "object", "properties": {"title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "subject": {"type": ["string", "null"], "description": "Subject"}, "useTaxIncludedPrices": {"type": "boolean", "description": "Indicates whether invoice prices and amount are tax included"}, "vatReverseCharge": {"type": "boolean", "description": "VAT reverse charge"}, "lines": {"type": ["array", "null"], "items": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Invoice line ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "description": {"type": ["string", "null"], "description": "Description (can be html)"}, "taxExcludedPrice": {"type": ["number", "null"], "description": "Tax excluded price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedPrice": {"type": ["number", "null"], "description": "Tax included price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "quantity": {"type": ["number", "null"], "description": "Quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "classificationId": {"type": ["integer", "null"], "description": "Classification ID (should be defined if line is product or service)", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxExcludedAmount": {"type": ["number", "null"], "description": "Tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": ["number", "null"], "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "date": {"type": ["string", "null"], "description": "Date", "format": "date"}, "type": {"enum": ["Empty", "Product", "Service", "Subtotal", "Text", "Deposit", "NewPage", "Title"], "type": "string"}, "productId": {"type": ["integer", "null"], "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "productNumber": {"type": ["string", "null"], "description": "Product number"}, "purchasePrice": {"type": ["number", "null"], "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginRate": {"type": "number", "description": "Margin rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "marginAmount": {"type": "number", "description": "Margin amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "disbursement": {"type": "boolean", "description": "Disbursement"}, "product": {"type": "object", "properties": {"id": {"type": "integer", "description": "Product ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"], "description": "Name"}, "number": {"type": ["string", "null"], "description": "Name"}, "classificationId": {"type": "integer", "description": "Classification ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salePrice": {"type": "number", "description": "Sale price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "isSalePriceTaxIncluded": {"type": "boolean", "description": "Indicates whether sale price include vat"}, "purchasePrice": {"type": "number", "description": "Purchase price", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "salesDefaultQuantity": {"type": "number", "description": "Sales default quantity", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "description": {"type": ["string", "null"], "description": "Description"}, "vatId": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "salesUnitId": {"type": ["integer", "null"], "description": "Sales unit ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "availableForSales": {"type": "boolean", "description": "Indicate whether the product can be sale"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Product"}, "vat": {"type": "object", "properties": {"id": {"type": ["integer", "null"], "description": "Vat ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "rate": {"type": ["number", "null"], "description": "Rate", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "region": {"enum": ["FR", "EU", "IE", "DOM"], "type": "string"}, "label": {"type": ["string", "null"], "description": "Label"}}, "additionalProperties": false, "description": "Vat"}}, "additionalProperties": false, "description": "Invoice line"}, "description": "Invoice lines"}, "grossTaxExcludedAmount": {"type": "number", "description": "Gross tax excluded amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "globalDiscount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "taxExcludedAmount": {"type": "number", "description": "Tax excluded amount (discount included)", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingAmount": {"type": "number", "description": "Shipping amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "shippingVatId": {"type": ["integer", "null"], "description": "Shipping VAT ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "taxAmount": {"type": "number", "description": "Total tax amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "dueAmount": {"type": "number", "description": "Total due", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "taxIncludedAmount": {"type": "number", "description": "Tax included amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "notes": {"type": ["string", "null"], "description": "Notes to be print"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference to be print"}, "pdfUrl": {"type": ["string", "null"], "description": "Pdf url"}}, "additionalProperties": false, "description": "Invoice"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/5e680891-007b-4317-94b5-dd0a2d0b3307/0/0
Altoviz
Invoicing and accounting APIs
null
PUT_Customers_Update
200
null
{"id": 0, "title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "companyInformations": {"siret": "", "vatNumber": ""}, "billingOptions": {"discount": {"type": "Percent", "value": 0}, "vatReverseCharge": true, "vendorReference": ""}, "type": "Company", "number": ""}
{"type": "object", "properties": {"id": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "title": {"type": ["string", "null"], "description": "Title"}, "lastName": {"type": ["string", "null"], "description": "Last name"}, "firstName": {"type": ["string", "null"], "description": "First name"}, "email": {"type": ["string", "null"], "description": "Email"}, "cellPhone": {"type": ["string", "null"], "description": "Cell phone number"}, "phone": {"type": ["string", "null"], "description": "Phone number"}, "companyName": {"type": ["string", "null"], "description": "Company name"}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "companyInformations": {"type": "object", "properties": {"siret": {"type": ["string", "null"]}, "vatNumber": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingOptions": {"type": "object", "properties": {"discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "vatReverseCharge": {"type": "boolean", "description": "Indicates VAT should be included in sales"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference. Used to be print on sales"}}, "additionalProperties": false, "description": "Billing options"}, "type": {"enum": ["Company", "Individual"], "type": "string"}, "number": {"type": ["string", "null"], "description": "Number"}}, "additionalProperties": false, "description": "Customer"}