Skip to content

Bazimo API (v1)

Languages
Servers
https://doc-api.bazimo.fr/

Authentications

Operations

Building

Operations

Expense

Operations

Invoice

Operations

Get Invoices By Building Id

Request

Return invoices for a specific building.

Path
tenantId_pathstringrequired
Body
datatableobject
buildingIdstring(uuid)
periodobject or null
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/invoice/getInvoicesByBuildingId' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "datatable": {
      "sort": {
        "sortBy": 1,
        "sortMode": 1
      },
      "pagination": {
        "page": 0,
        "rowsPerPage": 0
      },
      "filters": {},
      "search": {
        "value": "string"
      }
    },
    "buildingId": "fee3295a-6e55-45b0-a091-7b4de7e39de7",
    "period": {
      "periodEndAt": "string",
      "periodStartAt": "string"
    }
  }'

Responses

OK

Body
responseobject or nullread-only
errorsArray of stringsread-only
isFailurebooleanread-only
isSuccessbooleanread-only
Response
No response example

Get Invoice By Id

Request

Return a specific invoice by its Id.

Path
tenantId_pathstringrequired
Body
idstring(uuid)
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/invoice/getInvoiceById' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }'

Responses

OK

Body
responseobject or nullread-only
errorsArray of stringsread-only
isFailurebooleanread-only
isSuccessbooleanread-only
Response
No response example

Download Invoice (Should be Validated)

Request

Download the PDF of a specific invoice by its Id. The invoice should be validated.

Path
tenantId_pathstringrequired
Body
invoiceIdstring(uuid)
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/invoice/downloadInvoice' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec"
  }'

Responses

OK

Body
string(binary)
Response
No response example

Lease

Operations

LegalOwner

Operations

Lot

Operations

RealEstateCompany

Operations

Receipt

Operations

Renter

Operations

Supplier

Operations

User

Operations