Skip to content
/Expense

Bazimo API (v1)

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

Authentications

Operations

Building

Operations

Expense

Operations

Create a new expense

Request

Create a new expense on a building.

Path
tenantId_pathstringrequired
Body
billedOnstring or null
billingEndDatestring
billingStartDatestring
buildingIdstring(uuid)
commentstring or null
contractIdstring or null(uuid)
contractorIdstring(uuid)
supplierBankDetailsIdstring or null(uuid)
legalOwnerBankAccountIdstring or null(uuid)
detailsArray of objects
disbursementForecastDatestring or null
entryDatestring or null
labelstring
mediaIdstring or null(uuid)
numberstring
redditionModeinteger(int32)
Enum12
enumNames: ["Basic","Immediate"]
typeinteger(int32)
Enum12345699
enumNames: ["Insurance","Litigation","Contract","WorkOrder","OfficeTax","PropertyTax","Other"]
workLineCodestring or null
workOrderIdstring or null(uuid)
taxFillingModeinteger(int32)
Enum12
enumNames: ["Amount","TaxSystem"]
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/expense/createExpense' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "billedOn": "string",
    "billingEndDate": "string",
    "billingStartDate": "string",
    "buildingId": "fee3295a-6e55-45b0-a091-7b4de7e39de7",
    "comment": "string",
    "contractId": "dbf32426-cf38-4818-9c6e-3230d889fa51",
    "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",
    "supplierBankDetailsId": "11b9a205-e776-4fc2-abb9-1db4a152895d",
    "legalOwnerBankAccountId": "450dbb29-672e-4618-bf16-158f3a6d5955",
    "details": [
      {
        "allocationKeyId": "5401842c-871d-48e3-9973-c9cfbf868ecf",
        "amountVat": 0.1,
        "amountWithoutVat": 0.1,
        "taxSystem": 0,
        "endDate": "string",
        "expenseCategoryId": "21b21134-1430-4366-8ef8-91dd30d54041",
        "expenseChargebackType": 1,
        "label": "string",
        "number": "string",
        "startDate": "string",
        "workLineCode": "string"
      }
    ],
    "disbursementForecastDate": "string",
    "entryDate": "string",
    "label": "string",
    "mediaId": "5a8ffac5-2288-485d-b463-90c3cd9941ad",
    "number": "string",
    "redditionMode": 1,
    "type": 1,
    "workLineCode": "string",
    "workOrderId": "50150040-5a5c-4c26-9d75-30728d69a42e",
    "taxFillingMode": 1
  }'

Responses

OK

Body
idstring(uuid)
Response
No response example

Update an existing expense

Request

Update an expense if this is allowed.

Path
tenantId_pathstringrequired
Body
billedOnstring or null
billingEndDatestring
billingStartDatestring
commentstring or null
contractIdstring or null(uuid)
contractorIdstring(uuid)
detailsArray of objects
disbursementForecastDatestring or null
entryDatestring or null
idstring(uuid)
labelstring
mediaIdstring or null(uuid)
numberstring
redditionModeinteger(int32)
Enum12
enumNames: ["Basic","Immediate"]
taxFillingModeinteger(int32)
Enum12
enumNames: ["Amount","TaxSystem"]
supplierBankDetailsIdstring or null(uuid)
legalOwnerBankAccountIdstring or null(uuid)
typeinteger(int32)
Enum12345699
enumNames: ["Insurance","Litigation","Contract","WorkOrder","OfficeTax","PropertyTax","Other"]
workOrderIdstring or null(uuid)
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/expense/updateExpense' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "billedOn": "string",
    "billingEndDate": "string",
    "billingStartDate": "string",
    "comment": "string",
    "contractId": "dbf32426-cf38-4818-9c6e-3230d889fa51",
    "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",
    "details": [
      {
        "allocationKeyId": "5401842c-871d-48e3-9973-c9cfbf868ecf",
        "amountVat": 0.1,
        "amountWithoutVat": 0.1,
        "taxSystem": 0,
        "endDate": "string",
        "expenseCategoryId": "21b21134-1430-4366-8ef8-91dd30d54041",
        "expenseChargebackType": 1,
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "label": "string",
        "number": "string",
        "startDate": "string",
        "workLineCode": "string"
      }
    ],
    "disbursementForecastDate": "string",
    "entryDate": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "label": "string",
    "mediaId": "5a8ffac5-2288-485d-b463-90c3cd9941ad",
    "number": "string",
    "redditionMode": 1,
    "taxFillingMode": 1,
    "supplierBankDetailsId": "11b9a205-e776-4fc2-abb9-1db4a152895d",
    "legalOwnerBankAccountId": "450dbb29-672e-4618-bf16-158f3a6d5955",
    "type": 1,
    "workOrderId": "50150040-5a5c-4c26-9d75-30728d69a42e"
  }'

Responses

OK

Body
object
Response
No response example

Pay an expense

Request

Mark an expense as paid.

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

Responses

OK

Body
object
Response
No response example

Set an expense as ready to pay

Request

Mark an expense as ready to pay.

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

Responses

OK

Body
object
Response
No response example

Retrieve expenses by building id

Request

Return a list of expenses of the building.

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

Responses

OK

Body
datatableobject
facetsArray of objects
listArray of objects
isLegalOwnerRibDisplayedboolean
summaryobject
Response
No response example

Retrieve all expenses

Request

Return all expenses of all buildings that the user is allowed to see.

Path
tenantId_pathstringrequired
Body
datatableobject
periodobject or null
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/expense/getAllExpenses' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "datatable": {
      "sort": {
        "sortBy": 1,
        "sortMode": 1
      },
      "pagination": {
        "page": 0,
        "rowsPerPage": 0
      },
      "filters": {},
      "search": {
        "value": "string"
      }
    },
    "period": {
      "periodEndAt": "string",
      "periodStartAt": "string"
    }
  }'

Responses

OK

Body
datatableobject
facetsArray of objects
listArray of objects
Response
No response example

Retrieve expense by id

Request

Return expense data.

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

Responses

OK

Body
amountVatnumber or null(double)
amountVatPercentagenumber or null(double)
amountWithoutVatnumber(double)
amountWithVatnumber(double)
billedOnstring or null
billingPeriodEndDatestring
billingPeriodStartDatestring
canBeCancelledboolean
cancelledAtstring or null
cancelledByExpenseobject or null
cancelledByUserFullNamestring or null
cancelledByUserIdstring or null(uuid)
cancelledExpenseobject or null
commentstring or null
contractIdstring or null(uuid)
contractLabelstring or null
contractorIdstring(uuid)
contractorNamestring
contractorReferencestring
createdAtstring
createdByUserFullNamestring
createdByUserIdstring(uuid)
disbursementForecastDatestring or null
entryDatestring or null
idstring(uuid)
isCancelledboolean
labelstring
mediaIdstring or null(uuid)
numberstring
redditionModeinteger(int32)
Enum12
enumNames: ["Basic","Immediate"]
setAsReadyToPayAtstring or null
setAsReadyToPayByUserFullNamestring or null
setAsReadyToPayByUserIdstring or null(uuid)
settledAtstring or null
stateinteger(int32)
Enum1234
enumNames: ["Draft","Validated","ReadyToPay","Settled"]
supplierBankDetailsIdstring or null(uuid)
supplierBankDetailsWordingstring or null
legalOwnerBankAccountIdstring or null(uuid)
legalOwnerBankAccountLabelstring or null
typeinteger(int32)
Enum12345699
enumNames: ["Insurance","Litigation","Contract","WorkOrder","OfficeTax","PropertyTax","Other"]
validatedAtstring or null
validatedByUserFullNamestring or null
validatedByUserIdstring or null(uuid)
workOrderIdstring or null(uuid)
workOrderNumberstring or null
taxFillingModeinteger(int32)
Enum12
enumNames: ["Amount","TaxSystem"]
detailsArray of objects
Response
No response example

Retrieve building data by id

Request

Upload file linked to the expense.

Path
tenantId_pathstringrequired
Body
expenseIdstring(uuid)
invoicePdfUrlstring
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/expense/setExpenseMediaId' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "expenseId": "a2142719-090a-410b-ad70-ea5efeb1c9dc",
    "invoicePdfUrl": "string"
  }'

Responses

OK

Body
object
Response
No response example

Invoice

Operations

Lease

Operations

LegalOwner

Operations

Lot

Operations

RealEstateCompany

Operations

Receipt

Operations

Renter

Operations

Supplier

Operations

User

Operations