Altoviz API (v1)

Download OpenAPI specification:Download

Altoviz: contact@altoviz.com License: Altoviz license

RESTful APIs for the Altoviz services

Classifications

Classifications API

List all classifications

Authorizations:

ApiKey

query Parameters

type	string Enum: "Sale" "Expense" "Other" Classification Type

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url 'https://api.altoviz.com/v1/Classifications?type=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

application/json

[{"accountNumber": "string",
"defaultVat": {"default": true,
"id": 0,
"label": "string",
"rate": 0.1,
"region": "FR"
},
"description": "string",
"id": 0,
"isProduct": true,
"isService": true,
"label": "string",
"microBusinessDeclarationType": "Products",
"type": "Sale"
}
]

Contacts

Contacts API

List Contacts

Authorizations:

ApiKey

query Parameters

PageIndex	integer <int32>
PageSize	integer <int32>
OrderBy	string
query	string query (full text search)

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url 'https://api.altoviz.com/v1/Contacts?PageIndex=SOME_INTEGER_VALUE&PageSize=SOME_INTEGER_VALUE&OrderBy=SOME_STRING_VALUE&query=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

application/json

[{"cellPhone": "string",
"companyName": "string",
"displayName": "string",
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"invertedDisplayName": "string",
"lastName": "string",
"phone": "string",
"title": "string"
}
]

Create a new Contact

Authorizations:

ApiKey

Request Body schema:
application/json-patch+json

Contact to create

cellPhone	string or null
companyName	string or null
email	string or null
firstName	string or null
internalId	string or null ID used in your system
lastName	string or null
phone	string or null
title	string or null

Responses

Request samples

Content type

application/json-patch+json

{"cellPhone": "string",
"companyName": "string",
"email": "string",
"firstName": "string",
"internalId": "string",
"lastName": "string",
"phone": "string",
"title": "string"
}

Response samples

200
400

Content type

application/json

{"cellPhone": "string",
"companyName": "string",
"displayName": "string",
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"invertedDisplayName": "string",
"lastName": "string",
"phone": "string",
"title": "string"
}

Find a Contact

Authorizations:

ApiKey

query Parameters

email	string Email
internalId	string Internal ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url 'https://api.altoviz.com/v1/Contacts/Find?email=SOME_STRING_VALUE&internalId=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

application/json

[{"cellPhone": "string",
"companyName": "string",
"displayName": "string",
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"invertedDisplayName": "string",
"lastName": "string",
"phone": "string",
"title": "string"
}
]

Get a Contact by ID

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Contact id

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/Contacts/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
404

Content type

application/json

{"cellPhone": "string",
"companyName": "string",
"displayName": "string",
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"invertedDisplayName": "string",
"lastName": "string",
"phone": "string",
"title": "string"
}

Update a Contact

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Contact ID

Request Body schema:
application/json-patch+json

cellPhone	string or null
companyName	string or null
email	string or null
firstName	string or null
internalId	string or null ID used in your system
lastName	string or null
phone	string or null
title	string or null

Responses

Request samples

Content type

application/json-patch+json

{"cellPhone": "string",
"companyName": "string",
"email": "string",
"firstName": "string",
"internalId": "string",
"lastName": "string",
"phone": "string",
"title": "string"
}

Response samples

200
400
404

Content type

application/json

{"cellPhone": "string",
"companyName": "string",
"displayName": "string",
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"invertedDisplayName": "string",
"lastName": "string",
"phone": "string",
"title": "string"
}

Delete a Contact

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Contact id

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request DELETE \
  --url https://api.altoviz.com/v1/Contacts/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Customers

Customers API

List customers

Authorizations:

ApiKey

query Parameters

PageIndex	integer <int32>
PageSize	integer <int32>
OrderBy	string
query	string query (full text search)

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url 'https://api.altoviz.com/v1/Customers?PageIndex=SOME_INTEGER_VALUE&PageSize=SOME_INTEGER_VALUE&OrderBy=SOME_STRING_VALUE&query=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

application/json

[{"billingAddress": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"billingOptions": {"discount": {"type": "Percent",
"value": 0.1
},
"vatReverseCharge": true,
"vendorReference": "string"
},
"cellPhone": "string",
"companyInformations": {"siret": "string",
"vatNumber": "string"
},
"companyName": "string",
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"internalNotes": "string",
"lastName": "string",
"name": "string",
"number": "string",
"phone": "string",
"shippingAddress": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"title": "string",
"type": "Company"
}
]

Create a new customer

Authorizations:

ApiKey

Request Body schema:
application/json-patch+json

Customer to create

	object (AddressFields)
	object (BillingOptions) Billing options
cellPhone	string or null Cell phone number
	object (CompanyInfo)
companyName	string or null Company name
email	string or null Email
firstName	string or null First name
internalId	string or null ID used in information system
internalNotes	string or null Internal notes
lastName	string or null Last name
number	string or null Number
phone	string or null Phone number
	object (AddressFields)
title	string or null Title
type	string (PersonType) Enum: "Company" "Individual"

Responses

Request samples

Content type

application/json-patch+json

{"billingAddress": {"city": "string",
"countryIso": "string",
"street": "string",
"zipcode": "string"
},
"billingOptions": {"discount": {"type": "Percent",
"value": 0.1
},
"vatReverseCharge": true,
"vendorReference": "string"
},
"cellPhone": "string",
"companyInformations": {"siret": "string",
"vatNumber": "string"
},
"companyName": "string",
"email": "string",
"firstName": "string",
"internalId": "string",
"internalNotes": "string",
"lastName": "string",
"number": "string",
"phone": "string",
"shippingAddress": {"city": "string",
"countryIso": "string",
"street": "string",
"zipcode": "string"
},
"title": "string",
"type": "Company"
}

Response samples

200
400

Content type

application/json

{"billingAddress": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"billingOptions": {"discount": {"type": "Percent",
"value": 0.1
},
"vatReverseCharge": true,
"vendorReference": "string"
},
"cellPhone": "string",
"companyInformations": {"siret": "string",
"vatNumber": "string"
},
"companyName": "string",
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"internalNotes": "string",
"lastName": "string",
"name": "string",
"number": "string",
"phone": "string",
"shippingAddress": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"title": "string",
"type": "Company"
}

Find a customer by email

Authorizations:

ApiKey

query Parameters

email	string Customer email
internalId	string Customer internal ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url 'https://api.altoviz.com/v1/Customers/Find?email=SOME_STRING_VALUE&internalId=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

application/json

[{"billingAddress": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"billingOptions": {"discount": {"type": "Percent",
"value": 0.1
},
"vatReverseCharge": true,
"vendorReference": "string"
},
"cellPhone": "string",
"companyInformations": {"siret": "string",
"vatNumber": "string"
},
"companyName": "string",
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"internalNotes": "string",
"lastName": "string",
"name": "string",
"number": "string",
"phone": "string",
"shippingAddress": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"title": "string",
"type": "Company"
}
]

Find a single customer by its internal ID

Authorizations:

ApiKey

path Parameters

internalId

required

string

Customer internal ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/Customers/GetByInternalId/%7BinternalId%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

application/json

{"billingAddress": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"billingOptions": {"discount": {"type": "Percent",
"value": 0.1
},
"vatReverseCharge": true,
"vendorReference": "string"
},
"cellPhone": "string",
"companyInformations": {"siret": "string",
"vatNumber": "string"
},
"companyName": "string",
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"internalNotes": "string",
"lastName": "string",
"name": "string",
"number": "string",
"phone": "string",
"shippingAddress": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"title": "string",
"type": "Company"
}

Get a customer by ID

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Customer id

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/Customers/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
404

Content type

application/json

{"billingAddress": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"billingOptions": {"discount": {"type": "Percent",
"value": 0.1
},
"vatReverseCharge": true,
"vendorReference": "string"
},
"cellPhone": "string",
"companyInformations": {"siret": "string",
"vatNumber": "string"
},
"companyName": "string",
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"internalNotes": "string",
"lastName": "string",
"name": "string",
"number": "string",
"phone": "string",
"shippingAddress": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"title": "string",
"type": "Company"
}

Update a customer

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Customer ID

Request Body schema:
application/json-patch+json

	object (AddressFields)
	object (BillingOptions) Billing options
cellPhone	string or null Cell phone number
	object (CompanyInfo)
companyName	string or null Company name
email	string or null Email
firstName	string or null First name
internalId	string or null ID used in information system
internalNotes	string or null Internal notes
lastName	string or null Last name
number	string or null Number
phone	string or null Phone number
	object (AddressFields)
title	string or null Title
type	string (PersonType) Enum: "Company" "Individual"

Responses

Request samples

Content type

application/json-patch+json

{"billingAddress": {"city": "string",
"countryIso": "string",
"street": "string",
"zipcode": "string"
},
"billingOptions": {"discount": {"type": "Percent",
"value": 0.1
},
"vatReverseCharge": true,
"vendorReference": "string"
},
"cellPhone": "string",
"companyInformations": {"siret": "string",
"vatNumber": "string"
},
"companyName": "string",
"email": "string",
"firstName": "string",
"internalId": "string",
"internalNotes": "string",
"lastName": "string",
"number": "string",
"phone": "string",
"shippingAddress": {"city": "string",
"countryIso": "string",
"street": "string",
"zipcode": "string"
},
"title": "string",
"type": "Company"
}

Response samples

200
400
404

Content type

application/json

{"billingAddress": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"billingOptions": {"discount": {"type": "Percent",
"value": 0.1
},
"vatReverseCharge": true,
"vendorReference": "string"
},
"cellPhone": "string",
"companyInformations": {"siret": "string",
"vatNumber": "string"
},
"companyName": "string",
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"internalNotes": "string",
"lastName": "string",
"name": "string",
"number": "string",
"phone": "string",
"shippingAddress": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"title": "string",
"type": "Company"
}

Delete a customer

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Customer id

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request DELETE \
  --url https://api.altoviz.com/v1/Customers/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

404

Content type

application/json

{"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string",
"property1": null,
"property2": null
}

Get customer contacts

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Customer id

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/Customers/%7Bid%7D/contacts \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

application/json

[{"cellPhone": "string",
"companyName": "string",
"displayName": "string",
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"invertedDisplayName": "string",
"isMain": true,
"lastName": "string",
"phone": "string",
"title": "string"
}
]

Hello

User API

Say hello to test api key

Authorizations:

ApiKey

query Parameters

api-version

string

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url 'https://api.altoviz.com/Hello?api-version=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
401

Content type

text/plain

No sample

ProductFamilies

Products API

List product families

Authorizations:

ApiKey

query Parameters

PageIndex	integer <int32>
PageSize	integer <int32>
OrderBy	string
query	string query (full text search)

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url 'https://api.altoviz.com/v1/ProductFamilies?PageIndex=SOME_INTEGER_VALUE&PageSize=SOME_INTEGER_VALUE&OrderBy=SOME_STRING_VALUE&query=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

application/json

[{"id": 0,
"label": "string",
"number": "string"
}
]

Create a new product family

Authorizations:

ApiKey

Request Body schema:
application/json-patch+json

Product family to create

label	string or null Label
number	string or null Number

Responses

Request samples

Content type

application/json-patch+json

{"label": "string",
"number": "string"
}

Response samples

200
400

Content type

application/json

{"id": 0,
"label": "string",
"number": "string"
}

Get a product family by ID

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Product family id

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/ProductFamilies/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
404

Content type

application/json

{"id": 0,
"label": "string",
"number": "string"
}

Delete a product family

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Product family id

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request DELETE \
  --url https://api.altoviz.com/v1/ProductFamilies/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

404

Content type

application/json

{"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string",
"property1": null,
"property2": null
}

ProductImages

Product images API

Add or update the product image

Authorizations:

ApiKey

path Parameters

productId

required

integer <int32>

Product id

Request Body schema: multipart/form-data

ContentType	string
ContentDisposition	string
	object
Length	integer <int64>
Name	string
FileName	string

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request POST \
  --url https://api.altoviz.com/v1/ProductImages/%7BproductId%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE' \
  --header 'content-type: multipart/form-data'

Response samples

200
400

Content type

application/json

{"active": true,
"defaultQuantity": 0.1,
"description": "string",
"family": {"id": 0,
"label": "string",
"number": "string"
},
"id": 0,
"imageUrl": "string",
"internalId": "string",
"internalNotes": "string",
"isUnitPriceTaxIncluded": true,
"name": "string",
"number": "string",
"purchasePrice": 0.1,
"type": "Product",
"unit": {"code": "string",
"conversion": 0.1,
"decimals": 0.1,
"id": 0,
"name": "string",
"type": "Time"
},
"unitPrice": 0.1,
"vat": {"default": true,
"id": 0,
"label": "string",
"rate": 0.1,
"region": "FR"
}
}

Get a product image

Authorizations:

ApiKey

path Parameters

productId

required

integer <int32>

Product id

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/ProductImages/%7BproductId%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
404

Content type

application/json

{"active": true,
"defaultQuantity": 0.1,
"description": "string",
"family": {"id": 0,
"label": "string",
"number": "string"
},
"id": 0,
"imageUrl": "string",
"internalId": "string",
"internalNotes": "string",
"isUnitPriceTaxIncluded": true,
"name": "string",
"number": "string",
"purchasePrice": 0.1,
"type": "Product",
"unit": {"code": "string",
"conversion": 0.1,
"decimals": 0.1,
"id": 0,
"name": "string",
"type": "Time"
},
"unitPrice": 0.1,
"vat": {"default": true,
"id": 0,
"label": "string",
"rate": 0.1,
"region": "FR"
}
}

Delete a product image

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Product id

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request DELETE \
  --url https://api.altoviz.com/v1/ProductImages/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

404

Content type

application/json

{"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string",
"property1": null,
"property2": null
}

Products

Products API

List products

Authorizations:

ApiKey

query Parameters

PageIndex	integer <int32>
PageSize	integer <int32>
OrderBy	string
query	string query (full text search)
familyId	string Family ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url 'https://api.altoviz.com/v1/Products?PageIndex=SOME_INTEGER_VALUE&PageSize=SOME_INTEGER_VALUE&OrderBy=SOME_STRING_VALUE&query=SOME_STRING_VALUE&familyId=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

application/json

[{"active": true,
"defaultQuantity": 0.1,
"description": "string",
"family": {"id": 0,
"label": "string",
"number": "string"
},
"id": 0,
"imageUrl": "string",
"internalId": "string",
"internalNotes": "string",
"isUnitPriceTaxIncluded": true,
"name": "string",
"number": "string",
"purchasePrice": 0.1,
"type": "Product",
"unit": {"code": "string",
"conversion": 0.1,
"decimals": 0.1,
"id": 0,
"name": "string",
"type": "Time"
},
"unitPrice": 0.1,
"vat": {"default": true,
"id": 0,
"label": "string",
"rate": 0.1,
"region": "FR"
}
}
]

Create a new product

Authorizations:

ApiKey

Request Body schema:
application/json-patch+json

Product to create

active	boolean Indicates whether the product is active
defaultQuantity	number <double> Default quantity
description	string or null Description
	object (ProductFamily) Product family
internalId	string or null ID used in your system
internalNotes	string or null Internal notes
isUnitPriceTaxIncluded	boolean Indicates whether unit price include vat
name	string or null Name
number	string or null Number
purchasePrice	number <double> Purchase price
type	string (ProductType) Enum: "Product" "Service"
	object (Unit) Unit
unitPrice	number <double> Unit price
	object (Vat) Vat

Responses

Request samples

Content type

application/json-patch+json

{"active": true,
"defaultQuantity": 0.1,
"description": "string",
"family": {"label": "string",
"number": "string"
},
"internalId": "string",
"internalNotes": "string",
"isUnitPriceTaxIncluded": true,
"name": "string",
"number": "string",
"purchasePrice": 0.1,
"type": "Product",
"unit": {"code": "string",
"type": "Time"
},
"unitPrice": 0.1,
"vat": {"rate": 0.1,
"region": "FR"
}
}

Response samples

200
400

Content type

application/json

{"active": true,
"defaultQuantity": 0.1,
"description": "string",
"family": {"id": 0,
"label": "string",
"number": "string"
},
"id": 0,
"imageUrl": "string",
"internalId": "string",
"internalNotes": "string",
"isUnitPriceTaxIncluded": true,
"name": "string",
"number": "string",
"purchasePrice": 0.1,
"type": "Product",
"unit": {"code": "string",
"conversion": 0.1,
"decimals": 0.1,
"id": 0,
"name": "string",
"type": "Time"
},
"unitPrice": 0.1,
"vat": {"default": true,
"id": 0,
"label": "string",
"rate": 0.1,
"region": "FR"
}
}

Find a product

Authorizations:

ApiKey

query Parameters

number	string Number
internalId	string Internal ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url 'https://api.altoviz.com/v1/Products/Find?number=SOME_STRING_VALUE&internalId=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
404

Content type

application/json

[{"active": true,
"defaultQuantity": 0.1,
"description": "string",
"family": {"id": 0,
"label": "string",
"number": "string"
},
"id": 0,
"imageUrl": "string",
"internalId": "string",
"internalNotes": "string",
"isUnitPriceTaxIncluded": true,
"name": "string",
"number": "string",
"purchasePrice": 0.1,
"type": "Product",
"unit": {"code": "string",
"conversion": 0.1,
"decimals": 0.1,
"id": 0,
"name": "string",
"type": "Time"
},
"unitPrice": 0.1,
"vat": {"default": true,
"id": 0,
"label": "string",
"rate": 0.1,
"region": "FR"
}
}
]

Get a product by ID

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Product id

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/Products/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
404

Content type

application/json

{"active": true,
"defaultQuantity": 0.1,
"description": "string",
"family": {"id": 0,
"label": "string",
"number": "string"
},
"id": 0,
"imageUrl": "string",
"internalId": "string",
"internalNotes": "string",
"isUnitPriceTaxIncluded": true,
"name": "string",
"number": "string",
"purchasePrice": 0.1,
"type": "Product",
"unit": {"code": "string",
"conversion": 0.1,
"decimals": 0.1,
"id": 0,
"name": "string",
"type": "Time"
},
"unitPrice": 0.1,
"vat": {"default": true,
"id": 0,
"label": "string",
"rate": 0.1,
"region": "FR"
}
}

Update a product

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Product ID

Request Body schema:
application/json-patch+json

active	boolean Indicates whether the product is active
defaultQuantity	number <double> Default quantity
description	string or null Description
	object (ProductFamily) Product family
internalId	string or null ID used in your system
internalNotes	string or null Internal notes
isUnitPriceTaxIncluded	boolean Indicates whether unit price include vat
name	string or null Name
number	string or null Number
purchasePrice	number <double> Purchase price
type	string (ProductType) Enum: "Product" "Service"
	object (Unit) Unit
unitPrice	number <double> Unit price
	object (Vat) Vat

Responses

Request samples

Content type

application/json-patch+json

{"active": true,
"defaultQuantity": 0.1,
"description": "string",
"family": {"label": "string",
"number": "string"
},
"internalId": "string",
"internalNotes": "string",
"isUnitPriceTaxIncluded": true,
"name": "string",
"number": "string",
"purchasePrice": 0.1,
"type": "Product",
"unit": {"code": "string",
"type": "Time"
},
"unitPrice": 0.1,
"vat": {"rate": 0.1,
"region": "FR"
}
}

Response samples

200
404

Content type

application/json

{"active": true,
"defaultQuantity": 0.1,
"description": "string",
"family": {"id": 0,
"label": "string",
"number": "string"
},
"id": 0,
"imageUrl": "string",
"internalId": "string",
"internalNotes": "string",
"isUnitPriceTaxIncluded": true,
"name": "string",
"number": "string",
"purchasePrice": 0.1,
"type": "Product",
"unit": {"code": "string",
"conversion": 0.1,
"decimals": 0.1,
"id": 0,
"name": "string",
"type": "Time"
},
"unitPrice": 0.1,
"vat": {"default": true,
"id": 0,
"label": "string",
"rate": 0.1,
"region": "FR"
}
}

Delete a product

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Product id

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request DELETE \
  --url https://api.altoviz.com/v1/Products/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

404

Content type

application/json

{"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string",
"property1": null,
"property2": null
}

PurchaseInvoices

Purchase invoices API

Creates new purchase invoice from file

Authorizations:

ApiKey

Request Body schema: multipart/form-data

ContentType	string
ContentDisposition	string
	object
Length	integer <int64>
Name	string
FileName	string

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request POST \
  --url https://api.altoviz.com/v1/PurchaseInvoices/file \
  --header 'X-API-KEY: REPLACE_KEY_VALUE' \
  --header 'content-type: multipart/form-data'

Response samples

200

Content type

application/json

{"date": "2019-08-24",
"id": 0,
"notes": "string",
"pdfUrl": "string",
"reference": "string",
"region": "FR",
"status": "Done",
"subject": "string",
"supplier": {"address": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"cellPhone": "string",
"companyInformations": {"siret": "string",
"vatNumber": "string"
},
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"internalNotes": "string",
"lastName": "string",
"name": "string",
"number": "string",
"phone": "string",
"title": "string"
},
"taxIncludedAmount": 0.1,
"vatReverseCharge": true
}

Download the invoice as a PDF file

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/PurchaseInvoices/Download/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

404

Content type

application/json

{"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string",
"property1": null,
"property2": null
}

SaleCredits

Credits API

List credits

Authorizations:

ApiKey

query Parameters

PageIndex	integer <int32>
PageSize	integer <int32>
OrderBy	string
From	string <date> From
To	string <date> To
CustomerId	integer <int32> Customer ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url 'https://api.altoviz.com/v1/SaleCredits?PageIndex=SOME_INTEGER_VALUE&PageSize=SOME_INTEGER_VALUE&OrderBy=SOME_STRING_VALUE&From=SOME_STRING_VALUE&To=SOME_STRING_VALUE&CustomerId=SOME_INTEGER_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

text/plain

No sample

Create a new draft credit

Authorizations:

ApiKey

Request Body schema:
application/json-patch+json

	object (AddressFields)
	object (ContactFields)
customerId	integer or null <int32> Customer ID
customerName	string or null Customer name
customerNumber	string or null Customer number
customerOrderReference	string or null Customer order reference
customerVatNumber	string or null Customer VAT number
date	string or null <date> Date
footerNotes	string or null Footer notes to be print
	object (Discount)
headerNotes	string or null Header notes to be print
internalId	string or null ID used in your system
internalNotes	string or null Internal notes
liableToVat	boolean or null Indicates whether the document is liable to VAT
	Array of objects or null (SaleDocumentLine) Invoice lines
	object or null Metadata
number	string or null Number
publicLink	string or null Public link
region	string (VatRegion) Enum: "FR" "EU" "IE" "DOM" "Corse" "Monaco"
	object (AddressFields)
shippingAmount	number <double> Shipping amount
	object (ContactFields)
	object (Vat) Vat
subject	string or null Subject
useTaxIncludedPrices	boolean Indicates whether invoice prices and amount are tax included
vatMode	string (VatMode) Enum: "Auto" "Debit" "Collection"
vatNote	string or null VAT note to print
vatReverseCharge	boolean VAT reverse charge
vendorReference	string or null Vendor reference to be print

Responses

Request samples

Content type

application/json-patch+json

{"billingAddress": {"city": "string",
"countryIso": "string",
"street": "string",
"zipcode": "string"
},
"billingContact": {"cellPhone": "string",
"companyName": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"title": "string"
},
"customerId": 0,
"customerName": "string",
"customerNumber": "string",
"customerOrderReference": "string",
"customerVatNumber": "string",
"date": "2019-08-24",
"footerNotes": "string",
"globalDiscount": {"type": "Percent",
"value": 0.1
},
"headerNotes": "string",
"internalId": "string",
"internalNotes": "string",
"liableToVat": true,
"lines": [{"classificationId": 0,
"date": "2019-08-24",
"description": "string",
"discount": {"type": "Percent",
"value": 0.1
},
"marginAmount": 0.1,
"marginRate": 0.1,
"product": {"active": true,
"defaultQuantity": 0.1,
"description": "string",
"family": {"label": "string",
"number": "string"
},
"internalId": "string",
"internalNotes": "string",
"isUnitPriceTaxIncluded": true,
"name": "string",
"number": "string",
"purchasePrice": 0.1,
"type": "Product",
"unit": {"code": "string",
"type": "Time"
},
"unitPrice": 0.1,
"vat": {"rate": 0.1,
"region": "FR"
}
},
"productId": 0,
"productInternalId": "string",
"productNumber": "string",
"purchasePrice": 0.1,
"quantity": 0.1,
"taxExcludedPrice": 0.1,
"taxIncludedPrice": 0.1,
"type": "Empty",
"unit": {"code": "string",
"type": "Time"
},
"vat": {"rate": 0.1,
"region": "FR"
}
}
],
"metadata": {"property1": "string",
"property2": "string"
},
"number": "string",
"publicLink": "string",
"region": "FR",
"shippingAddress": {"city": "string",
"countryIso": "string",
"street": "string",
"zipcode": "string"
},
"shippingAmount": 0.1,
"shippingContact": {"cellPhone": "string",
"companyName": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"title": "string"
},
"shippingVat": {"rate": 0.1,
"region": "FR"
},
"subject": "string",
"useTaxIncludedPrices": true,
"vatMode": "Auto",
"vatNote": "string",
"vatReverseCharge": true,
"vendorReference": "string"
}

Response samples

200

Content type

text/plain

No sample

Get an credit by ID

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Credit ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/SaleCredits/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
404

Content type

text/plain

No sample

Update a draft credit

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Credit ID>

Request Body schema:
application/json-patch+json

	object (AddressFields)
	object (ContactFields)
customerId	integer or null <int32> Customer ID
customerName	string or null Customer name
customerNumber	string or null Customer number
customerOrderReference	string or null Customer order reference
customerVatNumber	string or null Customer VAT number
date	string or null <date> Date
footerNotes	string or null Footer notes to be print
	object (Discount)
headerNotes	string or null Header notes to be print
internalId	string or null ID used in your system
internalNotes	string or null Internal notes
liableToVat	boolean or null Indicates whether the document is liable to VAT
	Array of objects or null (SaleDocumentLine) Invoice lines
	object or null Metadata
number	string or null Number
publicLink	string or null Public link
region	string (VatRegion) Enum: "FR" "EU" "IE" "DOM" "Corse" "Monaco"
	object (AddressFields)
shippingAmount	number <double> Shipping amount
	object (ContactFields)
	object (Vat) Vat
subject	string or null Subject
useTaxIncludedPrices	boolean Indicates whether invoice prices and amount are tax included
vatMode	string (VatMode) Enum: "Auto" "Debit" "Collection"
vatNote	string or null VAT note to print
vatReverseCharge	boolean VAT reverse charge
vendorReference	string or null Vendor reference to be print

Responses

Request samples

Content type

application/json-patch+json

{"billingAddress": {"city": "string",
"countryIso": "string",
"street": "string",
"zipcode": "string"
},
"billingContact": {"cellPhone": "string",
"companyName": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"title": "string"
},
"customerId": 0,
"customerName": "string",
"customerNumber": "string",
"customerOrderReference": "string",
"customerVatNumber": "string",
"date": "2019-08-24",
"footerNotes": "string",
"globalDiscount": {"type": "Percent",
"value": 0.1
},
"headerNotes": "string",
"internalId": "string",
"internalNotes": "string",
"liableToVat": true,
"lines": [{"classificationId": 0,
"date": "2019-08-24",
"description": "string",
"discount": {"type": "Percent",
"value": 0.1
},
"marginAmount": 0.1,
"marginRate": 0.1,
"product": {"active": true,
"defaultQuantity": 0.1,
"description": "string",
"family": {"label": "string",
"number": "string"
},
"internalId": "string",
"internalNotes": "string",
"isUnitPriceTaxIncluded": true,
"name": "string",
"number": "string",
"purchasePrice": 0.1,
"type": "Product",
"unit": {"code": "string",
"type": "Time"
},
"unitPrice": 0.1,
"vat": {"rate": 0.1,
"region": "FR"
}
},
"productId": 0,
"productInternalId": "string",
"productNumber": "string",
"purchasePrice": 0.1,
"quantity": 0.1,
"taxExcludedPrice": 0.1,
"taxIncludedPrice": 0.1,
"type": "Empty",
"unit": {"code": "string",
"type": "Time"
},
"vat": {"rate": 0.1,
"region": "FR"
}
}
],
"metadata": {"property1": "string",
"property2": "string"
},
"number": "string",
"publicLink": "string",
"region": "FR",
"shippingAddress": {"city": "string",
"countryIso": "string",
"street": "string",
"zipcode": "string"
},
"shippingAmount": 0.1,
"shippingContact": {"cellPhone": "string",
"companyName": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"title": "string"
},
"shippingVat": {"rate": 0.1,
"region": "FR"
},
"subject": "string",
"useTaxIncludedPrices": true,
"vatMode": "Auto",
"vatNote": "string",
"vatReverseCharge": true,
"vendorReference": "string"
}

Response samples

200

Content type

text/plain

No sample

Delete a draft credit

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Draft credit ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request DELETE \
  --url https://api.altoviz.com/v1/SaleCredits/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
400

Content type

text/plain

No sample

Find credits

Authorizations:

ApiKey

query Parameters

internalId

string

Credit internal ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url 'https://api.altoviz.com/v1/SaleCredits/Find?internalId=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

text/plain

No sample

Finalize a draft credit

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Draft credit ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request POST \
  --url https://api.altoviz.com/v1/SaleCredits/Finalize/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
404

Content type

text/plain

No sample

Download the credit as a PDF file

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/SaleCredits/Download/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

404

Content type

text/plain

No sample

Send an credit

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Credit ID

Request Body schema:
application/json-patch+json

Email addresses

Array

string

Responses

Request samples

Content type

application/json-patch+json

["string"
]

Response samples

404

Content type

text/plain

No sample

SaleInvoices

Invoices API

List invoices

Authorizations:

ApiKey

query Parameters

PageIndex	integer <int32>
PageSize	integer <int32>
OrderBy	string
From	string <date> From
To	string <date> To
CustomerId	integer <int32> Customer ID
Status	string Enum: "Draft" "Incoming" "Expired" "Paid" "ToSend" Status
IncludeCancelled	boolean Indicates whether cancelled invoices should be included

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url 'https://api.altoviz.com/v1/SaleInvoices?PageIndex=SOME_INTEGER_VALUE&PageSize=SOME_INTEGER_VALUE&OrderBy=SOME_STRING_VALUE&From=SOME_STRING_VALUE&To=SOME_STRING_VALUE&CustomerId=SOME_INTEGER_VALUE&Status=SOME_STRING_VALUE&IncludeCancelled=SOME_BOOLEAN_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

text/plain

No sample

Create a new draft invoice

Authorizations:

ApiKey

Request Body schema:
application/json-patch+json

	object (AddressFields)
	object (ContactFields)
customerId	integer or null <int32> Customer ID
customerName	string or null Customer name
customerNumber	string or null Customer number
customerOrderReference	string or null Customer order reference
customerVatNumber	string or null Customer VAT number
date	string or null <date> Date
footerNotes	string or null Footer notes to be print
	object (Discount)
headerNotes	string or null Header notes to be print
internalId	string or null ID used in your system
internalNotes	string or null Internal notes
liableToVat	boolean or null Indicates whether the document is liable to VAT
	Array of objects or null (SaleDocumentLine) Invoice lines
	object or null Metadata
number	string or null Number
publicLink	string or null Public link
region	string (VatRegion) Enum: "FR" "EU" "IE" "DOM" "Corse" "Monaco"
	object (AddressFields)
shippingAmount	number <double> Shipping amount
	object (ContactFields)
	object (Vat) Vat
subject	string or null Subject
useTaxIncludedPrices	boolean Indicates whether invoice prices and amount are tax included
vatMode	string (VatMode) Enum: "Auto" "Debit" "Collection"
vatNote	string or null VAT note to print
vatReverseCharge	boolean VAT reverse charge
vendorReference	string or null Vendor reference to be print

Responses

Request samples

Content type

application/json-patch+json

{"billingAddress": {"city": "string",
"countryIso": "string",
"street": "string",
"zipcode": "string"
},
"billingContact": {"cellPhone": "string",
"companyName": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"title": "string"
},
"customerId": 0,
"customerName": "string",
"customerNumber": "string",
"customerOrderReference": "string",
"customerVatNumber": "string",
"date": "2019-08-24",
"footerNotes": "string",
"globalDiscount": {"type": "Percent",
"value": 0.1
},
"headerNotes": "string",
"internalId": "string",
"internalNotes": "string",
"liableToVat": true,
"lines": [{"classificationId": 0,
"date": "2019-08-24",
"description": "string",
"discount": {"type": "Percent",
"value": 0.1
},
"marginAmount": 0.1,
"marginRate": 0.1,
"product": {"active": true,
"defaultQuantity": 0.1,
"description": "string",
"family": {"label": "string",
"number": "string"
},
"internalId": "string",
"internalNotes": "string",
"isUnitPriceTaxIncluded": true,
"name": "string",
"number": "string",
"purchasePrice": 0.1,
"type": "Product",
"unit": {"code": "string",
"type": "Time"
},
"unitPrice": 0.1,
"vat": {"rate": 0.1,
"region": "FR"
}
},
"productId": 0,
"productInternalId": "string",
"productNumber": "string",
"purchasePrice": 0.1,
"quantity": 0.1,
"taxExcludedPrice": 0.1,
"taxIncludedPrice": 0.1,
"type": "Empty",
"unit": {"code": "string",
"type": "Time"
},
"vat": {"rate": 0.1,
"region": "FR"
}
}
],
"metadata": {"property1": "string",
"property2": "string"
},
"number": "string",
"publicLink": "string",
"region": "FR",
"shippingAddress": {"city": "string",
"countryIso": "string",
"street": "string",
"zipcode": "string"
},
"shippingAmount": 0.1,
"shippingContact": {"cellPhone": "string",
"companyName": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"title": "string"
},
"shippingVat": {"rate": 0.1,
"region": "FR"
},
"subject": "string",
"useTaxIncludedPrices": true,
"vatMode": "Auto",
"vatNote": "string",
"vatReverseCharge": true,
"vendorReference": "string"
}

Response samples

200

Content type

text/plain

No sample

Get an invoice by ID

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Invoice ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/SaleInvoices/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
404

Content type

text/plain

No sample

Update a draft invoice

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Invoice ID>

Request Body schema:
application/json-patch+json

	object (AddressFields)
	object (ContactFields)
customerId	integer or null <int32> Customer ID
customerName	string or null Customer name
customerNumber	string or null Customer number
customerOrderReference	string or null Customer order reference
customerVatNumber	string or null Customer VAT number
date	string or null <date> Date
footerNotes	string or null Footer notes to be print
	object (Discount)
headerNotes	string or null Header notes to be print
internalId	string or null ID used in your system
internalNotes	string or null Internal notes
liableToVat	boolean or null Indicates whether the document is liable to VAT
	Array of objects or null (SaleDocumentLine) Invoice lines
	object or null Metadata
number	string or null Number
publicLink	string or null Public link
region	string (VatRegion) Enum: "FR" "EU" "IE" "DOM" "Corse" "Monaco"
	object (AddressFields)
shippingAmount	number <double> Shipping amount
	object (ContactFields)
	object (Vat) Vat
subject	string or null Subject
useTaxIncludedPrices	boolean Indicates whether invoice prices and amount are tax included
vatMode	string (VatMode) Enum: "Auto" "Debit" "Collection"
vatNote	string or null VAT note to print
vatReverseCharge	boolean VAT reverse charge
vendorReference	string or null Vendor reference to be print

Responses

Request samples

Content type

application/json-patch+json

{"billingAddress": {"city": "string",
"countryIso": "string",
"street": "string",
"zipcode": "string"
},
"billingContact": {"cellPhone": "string",
"companyName": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"title": "string"
},
"customerId": 0,
"customerName": "string",
"customerNumber": "string",
"customerOrderReference": "string",
"customerVatNumber": "string",
"date": "2019-08-24",
"footerNotes": "string",
"globalDiscount": {"type": "Percent",
"value": 0.1
},
"headerNotes": "string",
"internalId": "string",
"internalNotes": "string",
"liableToVat": true,
"lines": [{"classificationId": 0,
"date": "2019-08-24",
"description": "string",
"discount": {"type": "Percent",
"value": 0.1
},
"marginAmount": 0.1,
"marginRate": 0.1,
"product": {"active": true,
"defaultQuantity": 0.1,
"description": "string",
"family": {"label": "string",
"number": "string"
},
"internalId": "string",
"internalNotes": "string",
"isUnitPriceTaxIncluded": true,
"name": "string",
"number": "string",
"purchasePrice": 0.1,
"type": "Product",
"unit": {"code": "string",
"type": "Time"
},
"unitPrice": 0.1,
"vat": {"rate": 0.1,
"region": "FR"
}
},
"productId": 0,
"productInternalId": "string",
"productNumber": "string",
"purchasePrice": 0.1,
"quantity": 0.1,
"taxExcludedPrice": 0.1,
"taxIncludedPrice": 0.1,
"type": "Empty",
"unit": {"code": "string",
"type": "Time"
},
"vat": {"rate": 0.1,
"region": "FR"
}
}
],
"metadata": {"property1": "string",
"property2": "string"
},
"number": "string",
"publicLink": "string",
"region": "FR",
"shippingAddress": {"city": "string",
"countryIso": "string",
"street": "string",
"zipcode": "string"
},
"shippingAmount": 0.1,
"shippingContact": {"cellPhone": "string",
"companyName": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"title": "string"
},
"shippingVat": {"rate": 0.1,
"region": "FR"
},
"subject": "string",
"useTaxIncludedPrices": true,
"vatMode": "Auto",
"vatNote": "string",
"vatReverseCharge": true,
"vendorReference": "string"
}

Response samples

200

Content type

text/plain

No sample

Delete a draft invoice

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Draft invoice ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request DELETE \
  --url https://api.altoviz.com/v1/SaleInvoices/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
400

Content type

text/plain

No sample

Find invoices

Authorizations:

ApiKey

query Parameters

internalId

string

Invoice internal ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url 'https://api.altoviz.com/v1/SaleInvoices/Find?internalId=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

text/plain

No sample

Finalize a draft invoice

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Draft invoice ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request POST \
  --url https://api.altoviz.com/v1/SaleInvoices/Finalize/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
404

Content type

text/plain

No sample

Mark invoice as paid

Authorizations:

ApiKey

Request Body schema:
application/json-patch+json

amount	number or null <double> Amount to pay
date	string <date> Paid date
finalizeInvoice	boolean Indicates whether the invoice has to be finalized if draft
invoiceId	integer <int32> Invoice ID
	object or null Meta data
paymentMethod	string (PaymentMethod) Enum: "Transfer" "Order" "Check" "Cash" "Card" "Bill" "Other"
paymentReference	string or null Payment reference

Responses

Request samples

Content type

application/json-patch+json

{"amount": 0.1,
"date": "2019-08-24",
"finalizeInvoice": true,
"invoiceId": 0,
"metadata": {"property1": "string",
"property2": "string"
},
"paymentMethod": "Transfer",
"paymentReference": "string"
}

Response samples

200
404

Content type

text/plain

No sample

Download the invoice as a PDF file

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/SaleInvoices/Download/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

404

Content type

text/plain

No sample

Send an invoice

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Invoice ID

Request Body schema:
application/json-patch+json

Email addresses

Array

string

Responses

Request samples

Content type

application/json-patch+json

["string"
]

Response samples

404

Content type

text/plain

No sample

SaleQuotes

Quotes API

List quotes

Authorizations:

ApiKey

query Parameters

PageIndex	integer <int32>
PageSize	integer <int32>
OrderBy	string
From	string <date> From
To	string <date> To
CustomerId	integer <int32> Customer ID
Status.From	string <date> From
Status.To	string <date> To
Status.CustomerId	integer <int32> Customer ID
Status.Status.From	string <date> From
Status.Status.To	string <date> To
Status.Status.CustomerId	integer <int32> Customer ID
	object Status

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url 'https://api.altoviz.com/v1/SaleQuotes?PageIndex=SOME_INTEGER_VALUE&PageSize=SOME_INTEGER_VALUE&OrderBy=SOME_STRING_VALUE&From=SOME_STRING_VALUE&To=SOME_STRING_VALUE&CustomerId=SOME_INTEGER_VALUE&Status.From=SOME_STRING_VALUE&Status.To=SOME_STRING_VALUE&Status.CustomerId=SOME_INTEGER_VALUE&Status.Status.From=SOME_STRING_VALUE&Status.Status.To=SOME_STRING_VALUE&Status.Status.CustomerId=SOME_INTEGER_VALUE&Status.Status.Status=SOME_OBJECT_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

text/plain

No sample

Create a new quote

Authorizations:

ApiKey

Request Body schema:
application/json-patch+json

acceptedAt	string or null <date-time> Accepted date
	object (AddressFields)
	object (ContactFields)
customerId	integer or null <int32> Customer ID
customerName	string or null Customer name
customerNumber	string or null Customer number
customerOrderReference	string or null Customer order reference
customerVatNumber	string or null Customer VAT number
date	string or null <date> Date
	object (Discount)
footerNotes	string or null Footer notes to be print
	object (Discount)
headerNotes	string or null Header notes to be print
internalId	string or null ID used in your system
internalNotes	string or null Internal notes
liableToVat	boolean or null Indicates whether the document is liable to VAT
	Array of objects or null (SaleDocumentLine) Invoice lines
	object or null Metadata
number	string or null Number
publicLink	string or null Public link
refusedAt	string or null <date-time> Refused date
region	string (VatRegion) Enum: "FR" "EU" "IE" "DOM" "Corse" "Monaco"
	object (AddressFields)
shippingAmount	number <double> Shipping amount
	object (ContactFields)
	object (Vat) Vat
status	string (QuoteStatus) Enum: "Pending" "Accepted" "Refused" "Closed" "Sent" "Invoiced"
subject	string or null Subject
useTaxIncludedPrices	boolean Indicates whether invoice prices and amount are tax included
validityDate	string or null <date> Validity date
vatNote	string or null VAT note to print
vatReverseCharge	boolean VAT reverse charge
vendorReference	string or null Vendor reference to be print

Responses

Request samples

Content type

application/json-patch+json

{"acceptedAt": "2019-08-24T14:15:22Z",
"billingAddress": {"city": "string",
"countryIso": "string",
"street": "string",
"zipcode": "string"
},
"billingContact": {"cellPhone": "string",
"companyName": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"title": "string"
},
"customerId": 0,
"customerName": "string",
"customerNumber": "string",
"customerOrderReference": "string",
"customerVatNumber": "string",
"date": "2019-08-24",
"deposit": {"type": "Percent",
"value": 0.1
},
"footerNotes": "string",
"globalDiscount": {"type": "Percent",
"value": 0.1
},
"headerNotes": "string",
"internalId": "string",
"internalNotes": "string",
"liableToVat": true,
"lines": [{"classificationId": 0,
"date": "2019-08-24",
"description": "string",
"discount": {"type": "Percent",
"value": 0.1
},
"marginAmount": 0.1,
"marginRate": 0.1,
"product": {"active": true,
"defaultQuantity": 0.1,
"description": "string",
"family": {"label": "string",
"number": "string"
},
"internalId": "string",
"internalNotes": "string",
"isUnitPriceTaxIncluded": true,
"name": "string",
"number": "string",
"purchasePrice": 0.1,
"type": "Product",
"unit": {"code": "string",
"type": "Time"
},
"unitPrice": 0.1,
"vat": {"rate": 0.1,
"region": "FR"
}
},
"productId": 0,
"productInternalId": "string",
"productNumber": "string",
"purchasePrice": 0.1,
"quantity": 0.1,
"taxExcludedPrice": 0.1,
"taxIncludedPrice": 0.1,
"type": "Empty",
"unit": {"code": "string",
"type": "Time"
},
"vat": {"rate": 0.1,
"region": "FR"
}
}
],
"metadata": {"property1": "string",
"property2": "string"
},
"number": "string",
"publicLink": "string",
"refusedAt": "2019-08-24T14:15:22Z",
"region": "FR",
"shippingAddress": {"city": "string",
"countryIso": "string",
"street": "string",
"zipcode": "string"
},
"shippingAmount": 0.1,
"shippingContact": {"cellPhone": "string",
"companyName": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"title": "string"
},
"shippingVat": {"rate": 0.1,
"region": "FR"
},
"status": "Pending",
"subject": "string",
"useTaxIncludedPrices": true,
"validityDate": "2019-08-24",
"vatNote": "string",
"vatReverseCharge": true,
"vendorReference": "string"
}

Response samples

200

Content type

text/plain

No sample

Get an quote by ID

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Quote ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/SaleQuotes/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
404

Content type

text/plain

No sample

Delete a quote

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Quote ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request DELETE \
  --url https://api.altoviz.com/v1/SaleQuotes/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
400

Content type

text/plain

No sample

Find quotes

Authorizations:

ApiKey

query Parameters

internalId

string

Quote internal ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url 'https://api.altoviz.com/v1/SaleQuotes/Find?internalId=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

text/plain

No sample

Download the quote as a PDF file

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/SaleQuotes/Download/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

404

Content type

text/plain

No sample

Send an quote

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Request Body schema:
application/json-patch+json

Array

string

Responses

Request samples

Content type

application/json-patch+json

["string"
]

Response samples

404

Content type

text/plain

No sample

Settings

Settings API

Get settings

Authorizations:

ApiKey

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/Settings \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

application/json

{"accounting": {"accountNumberLength": 0,
"customerAccountFormat": "string",
"customerCollectiveAccount": 0,
"expensesImportVatReverseAccountNumber": "string",
"expensesJournalCode": "string",
"expensesSubcontractingVatReverseAccountNumber": "string",
"feesAccountingAccountNumber": "string",
"generateCustomerAccount": true,
"generateSupplierAccount": true,
"miscJournalCode": "string",
"salesDepositAccountingAccountNumber": "string",
"salesJournalCode": "string",
"salesShippingAccountNumber": "string",
"salesVatCollectionAccountingAccountNumber": "string",
"supplierAccountFormat": "string",
"supplierCollectiveAccount": 0,
"uncertainAccountNumberRoot": "string"
},
"company": {"ape": "string",
"capital": 0.1,
"contact": {"cellPhone": "string",
"companyName": "string",
"displayName": "string",
"email": "string",
"firstName": "string",
"invertedDisplayName": "string",
"lastName": "string",
"phone": "string",
"title": "string"
},
"emailLogoUri": "string",
"headOfficeAddress": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"invoicingAddress": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"isMicroBusiness": true,
"legalStatus": "string",
"logoUri": "string",
"name": "string",
"registrationNumber": "string",
"reportLogoUri": "string",
"siret": "string",
"summary": "string",
"urlCompanyName": "string",
"useInvoicingAddressAsHeadOfficeAddress": true,
"vatNumber": "string",
"website": "string"
},
"emailing": {"credits": {"defaultAttachments": [{"fileId": 0,
"fileName": "string",
"fileSize": 0.1
}
],
"defaultBccEmails": ["string"
],
"defaultCcEmails": ["string"
],
"defaultContentTemplate": "string",
"defaultObjectTemplate": "string",
"includeDocumentAttachment": true,
"showAmount": true
},
"invoices": {"defaultAttachments": [{"fileId": 0,
"fileName": "string",
"fileSize": 0.1
}
],
"defaultBccEmails": ["string"
],
"defaultCcEmails": ["string"
],
"defaultContentTemplate": "string",
"defaultObjectTemplate": "string",
"includeDocumentAttachment": true,
"showAmount": true
},
"quotes": {"defaultAttachments": [{"fileId": 0,
"fileName": "string",
"fileSize": 0.1
}
],
"defaultBccEmails": ["string"
],
"defaultCcEmails": ["string"
],
"defaultContentTemplate": "string",
"defaultObjectTemplate": "string",
"includeDocumentAttachment": true,
"showAmount": true
},
"reminders": {"defaultAttachments": [{"fileId": 0,
"fileName": "string",
"fileSize": 0.1
}
],
"defaultBccEmails": ["string"
],
"defaultCcEmails": ["string"
],
"defaultContentTemplate": "string",
"defaultObjectTemplate": "string",
"includeDocumentAttachment": true
},
"style": {"backgroundColor": "string",
"foreColor": "string",
"headerBackgroundColor": "string",
"headerForeColor": "string"
}
},
"general": {"contactDisplayFormat": "NameFirstName",
"timezone": "string"
},
"sales": {"allowInlineDate": true,
"btoBSettlementTerm": {"conditions": [{"dayOfMonth": 0,
"delay": 0,
"id": 0,
"percent": 0.1,
"type": "Net"
}
],
"id": 0,
"isCustom": true,
"name": "string"
},
"btoBSettlementTermId": 0,
"btoCSettlementTerm": {"conditions": [{"dayOfMonth": 0,
"delay": 0,
"id": 0,
"percent": 0.1,
"type": "Net"
}
],
"id": 0,
"isCustom": true,
"name": "string"
},
"btoCSettlementTermId": 0,
"credits": {"validityDuration": 0
},
"defaultProductClassification": {"accountNumber": "string",
"defaultVat": {"default": true,
"id": 0,
"rate": 0.1,
"region": "FR"
},
"description": "string",
"id": 0,
"isProduct": true,
"isService": true,
"label": "string",
"metadatas": {"property1": "string",
"property2": "string"
},
"microBusinessDeclarationType": "Products",
"type": "Sale"
},
"defaultServiceClassification": {"accountNumber": "string",
"defaultVat": {"default": true,
"id": 0,
"rate": 0.1,
"region": "FR"
},
"description": "string",
"id": 0,
"isProduct": true,
"isService": true,
"label": "string",
"metadatas": {"property1": "string",
"property2": "string"
},
"microBusinessDeclarationType": "Products",
"type": "Sale"
},
"defaultShippingClassification": {"accountNumber": "string",
"defaultVat": {"default": true,
"id": 0,
"rate": 0.1,
"region": "FR"
},
"description": "string",
"id": 0,
"isProduct": true,
"isService": true,
"label": "string",
"metadatas": {"property1": "string",
"property2": "string"
},
"microBusinessDeclarationType": "Products",
"type": "Sale"
},
"generalTermsFile": {"description": "string",
"externalLinkHash": "string",
"fileName": "string",
"folderId": 0,
"id": 0,
"metadatas": {"property1": "string",
"property2": "string"
},
"size": 0.1,
"system": true,
"uploadedAt": "2019-08-24T14:15:22Z"
},
"generalTermsFileId": 0,
"invoices": {"collectionCosts": "string",
"latePaymentPenalty": "string",
"substractDepositFromTaxExcludedAmount": true
},
"mainActivity": "Product",
"marginRate": 0.1,
"paymentMethod": "Transfer",
"quotes": {"depositDefaultValue": 0.1,
"validityDuration": 0
},
"useTaxIncluded": true,
"vatReverseCharge": true
},
"socials": {"facebook": "string",
"instagram": "string",
"linkedIn": "string",
"pinterest": "string",
"twitter": "string",
"youtube": "string"
},
"vat": {"liableToVat": true,
"nonLiableTextToPrint": "string",
"vatMode": "Auto",
"vatPeriod": "Monthly"
}
}

Suppliers

Suppliers API

List suppliers

Authorizations:

ApiKey

query Parameters

PageIndex	integer <int32>
PageSize	integer <int32>
OrderBy	string
query	string query (full text search)

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url 'https://api.altoviz.com/v1/Suppliers?PageIndex=SOME_INTEGER_VALUE&PageSize=SOME_INTEGER_VALUE&OrderBy=SOME_STRING_VALUE&query=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

application/json

[{"address": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"cellPhone": "string",
"companyInformations": {"siret": "string",
"vatNumber": "string"
},
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"internalNotes": "string",
"lastName": "string",
"name": "string",
"number": "string",
"phone": "string",
"title": "string"
}
]

Create a new supplier

Authorizations:

ApiKey

Request Body schema:
application/json-patch+json

Supplier to create

	object (AddressFields)
cellPhone	string or null Cell phone number
	object (CompanyInfo)
email	string or null Email
firstName	string or null First name
internalId	string or null Internal Id
internalNotes	string or null Internal notes
lastName	string or null Last name
name	string or null Company name
number	string or null Number
phone	string or null Phone number
title	string or null Title

Responses

Request samples

Content type

application/json-patch+json

{"address": {"city": "string",
"countryIso": "string",
"street": "string",
"zipcode": "string"
},
"cellPhone": "string",
"companyInformations": {"siret": "string",
"vatNumber": "string"
},
"email": "string",
"firstName": "string",
"internalId": "string",
"internalNotes": "string",
"lastName": "string",
"name": "string",
"number": "string",
"phone": "string",
"title": "string"
}

Response samples

200
400

Content type

application/json

{"address": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"cellPhone": "string",
"companyInformations": {"siret": "string",
"vatNumber": "string"
},
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"internalNotes": "string",
"lastName": "string",
"name": "string",
"number": "string",
"phone": "string",
"title": "string"
}

Find a customer by email

Authorizations:

ApiKey

query Parameters

email	string Supplier email
internalId	string Supplier internal ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url 'https://api.altoviz.com/v1/Suppliers/Find?email=SOME_STRING_VALUE&internalId=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

application/json

[{"address": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"cellPhone": "string",
"companyInformations": {"siret": "string",
"vatNumber": "string"
},
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"internalNotes": "string",
"lastName": "string",
"name": "string",
"number": "string",
"phone": "string",
"title": "string"
}
]

Find a single supplier by its internal ID

Authorizations:

ApiKey

path Parameters

internalId

required

string

Supplier internal ID

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/Suppliers/GetByInternalId/%7BinternalId%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

application/json

{"address": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"cellPhone": "string",
"companyInformations": {"siret": "string",
"vatNumber": "string"
},
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"internalNotes": "string",
"lastName": "string",
"name": "string",
"number": "string",
"phone": "string",
"title": "string"
}

Get a supplier by ID

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Supplier id

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/Suppliers/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
404

Content type

application/json

{"address": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"cellPhone": "string",
"companyInformations": {"siret": "string",
"vatNumber": "string"
},
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"internalNotes": "string",
"lastName": "string",
"name": "string",
"number": "string",
"phone": "string",
"title": "string"
}

Update a supplier

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Supplier ID

Request Body schema:
application/json-patch+json

	object (AddressFields)
cellPhone	string or null Cell phone number
	object (CompanyInfo)
email	string or null Email
firstName	string or null First name
internalId	string or null Internal Id
internalNotes	string or null Internal notes
lastName	string or null Last name
name	string or null Company name
number	string or null Number
phone	string or null Phone number
title	string or null Title

Responses

Request samples

Content type

application/json-patch+json

{"address": {"city": "string",
"countryIso": "string",
"street": "string",
"zipcode": "string"
},
"cellPhone": "string",
"companyInformations": {"siret": "string",
"vatNumber": "string"
},
"email": "string",
"firstName": "string",
"internalId": "string",
"internalNotes": "string",
"lastName": "string",
"name": "string",
"number": "string",
"phone": "string",
"title": "string"
}

Response samples

200
400
404

Content type

application/json

{"address": {"city": "string",
"countryIso": "string",
"countryName": "string",
"formattedAddress": "string",
"inlineAddress": "string",
"street": "string",
"zipcode": "string"
},
"cellPhone": "string",
"companyInformations": {"siret": "string",
"vatNumber": "string"
},
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"internalNotes": "string",
"lastName": "string",
"name": "string",
"number": "string",
"phone": "string",
"title": "string"
}

Delete a supplier

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Supplier id

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request DELETE \
  --url https://api.altoviz.com/v1/Suppliers/%7Bid%7D \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

404

Content type

application/json

{"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string",
"property1": null,
"property2": null
}

Get supplier contacts

Authorizations:

ApiKey

path Parameters

id

required

integer <int32>

Supplier id

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/Suppliers/%7Bid%7D/contacts \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

application/json

[{"cellPhone": "string",
"companyName": "string",
"displayName": "string",
"email": "string",
"firstName": "string",
"id": 0,
"internalId": "string",
"invertedDisplayName": "string",
"isMain": true,
"lastName": "string",
"phone": "string",
"title": "string"
}
]

Units

Units API

List all units

Authorizations:

ApiKey

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/Units \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

application/json

[{"code": "string",
"conversion": 0.1,
"decimals": 0.1,
"id": 0,
"name": "string",
"type": "Time"
}
]

Users

User API

User

Authorizations:

ApiKey

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/Users/me \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
400

Content type

application/json

{"displayName": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"profile": "Admin",
"status": "Inactive",
"userId": "string"
}

User

Authorizations:

ApiKey

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/Users/whoami \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
400

Content type

application/json

{"displayName": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"profile": "Admin",
"status": "Inactive",
"userId": "string"
}

Vats

Vats API

List all vats

Authorizations:

ApiKey

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/Vats \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

application/json

[{"default": true,
"id": 0,
"label": "string",
"rate": 0.1,
"region": "FR"
}
]

Webhooks

Classifications API

List all webhooks

Authorizations:

ApiKey

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request GET \
  --url https://api.altoviz.com/v1/Webhooks \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200

Content type

application/json

[{"id": 0,
"name": "string",
"secretKey": "string",
"types": ["CustomerCreated"
],
"url": "string"
}
]

Register a new webhook

Authorizations:

ApiKey

Request Body schema:
application/json-patch+json

name required	string non-empty Name
secretKey	string or null Secret key
types required	Array of strings (WebhookType) Items Enum: "CustomerCreated" "InvoiceCreated" "CustomerDeleted" "CustomerUpdated" "ProductCreated" "ProductUpdated" "ProductDeleted" "InvoiceUpdated" "ContactUpdated" "ContactCreated" "QuoteUpdated" "QuoteCreated" "ContactDeleted" "QuoteDeleted" "InvoiceDeleted"
url required	string non-empty Webhook Uri

Responses

Request samples

Content type

application/json-patch+json

{"name": "string",
"secretKey": "string",
"types": ["CustomerCreated"
],
"url": "string"
}

Response samples

200
400

Content type

application/json

{"id": 0,
"name": "string",
"secretKey": "string",
"types": ["CustomerCreated"
],
"url": "string"
}

Unregister a webhook

Authorizations:

ApiKey

query Parameters

id	integer <int32> Webhook ID
url	string Webhook URL

Responses

Request samples

Shell + Curl
Node + Request
Csharp + Httpclient
Python + Python3
Php + Http2

curl --request DELETE \
  --url 'https://api.altoviz.com/v1/Webhooks?id=SOME_INTEGER_VALUE&url=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

200
404

Content type

application/json

{"id": 0,
"name": "string",
"secretKey": "string",
"types": ["CustomerCreated"
],
"url": "string"
}

Altoviz API (v1)

Classifications

List all classifications

Authorizations:

query Parameters

Responses

Request samples

Response samples

Contacts

List Contacts

Authorizations:

query Parameters

Responses

Request samples

Response samples

Create a new Contact

Authorizations:

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Responses

Request samples

Response samples

Find a Contact

Authorizations:

query Parameters

Responses

Request samples

Response samples

Get a Contact by ID

Authorizations:

path Parameters

Responses

Request samples

Response samples

Update a Contact

Authorizations:

path Parameters

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Responses

Request samples

Response samples

Delete a Contact

Authorizations:

path Parameters

Responses

Request samples

Customers

List customers

Authorizations:

query Parameters

Responses

Request samples

Response samples

Create a new customer

Authorizations:

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Responses

Request samples

Response samples

Find a customer by email

Authorizations:

query Parameters

Responses

Request samples

Response samples

Find a single customer by its internal ID

Authorizations:

path Parameters

Responses

Request samples

Response samples

Get a customer by ID

Authorizations:

path Parameters

Responses

Request samples

Response samples

Update a customer

Authorizations:

path Parameters

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json