Skip to content
/Receipt

Bazimo API (v1)

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

Authentications

Operations

Building

Operations

Expense

Operations

Invoice

Operations

Lease

Operations

LegalOwner

Operations

Lot

Operations

RealEstateCompany

Operations

Receipt

Operations

Retrieve receipts and refunds by building id

Request

Return a list of receipts and refunds for a specific building

Path
tenantId_pathstringrequired
Body
buildingIdstring(uuid)
datatableobject
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/receipts/GetReceiptsAndRefundsByBuildingId' \
  -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"
      }
    }
  }'

Responses

OK

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

Retrieve receipt by id

Request

Return a receipt by its unique identifier

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

Responses

OK

Body
amountnumber(double)
canceledByVariousOperationobject or null
commentstring or null
createdAtstring(date-time)
createdByUserIdstring(uuid)
createdByUserFirstNamestring or null
createdByUserLastNamestring or null
updatedAtstring or null(date-time)
updatedByUserIdstring or null(uuid)
updatedByUserFirstNamestring or null
updatedByUserLastNamestring or null
validatedAtstring or null
validatedByUserIdstring or null(uuid)
validatedByUserFirstNamestring or null
validatedByUserLastNamestring or null
externalBalanceRecoveriesArray of objects
hasGreaterThanZeroSuspenseAccountLineboolean
idstring(uuid)
invoicesArray of objects
isCancelledboolean
labelstring
leasesArray of objects
numberstring or null
paymentMethodinteger(int32)
Enum123
enumNames: ["Check","BankTransfer","DirectDebit"]
paymentReferencestring or null
buildingIdstring(uuid)
buildingNamestring
buildingReferencestring
renterIdstring(uuid)
renterNamestring
settledOnstring
stateinteger(int32)
Enum12
enumNames: ["Draft","Validated"]
suspenseAccountLineAmountnumber or null(double)
suspenseAccountRefundsArray of objects
isImportedboolean
Response
No response example

Retrieve next receipt number

Request

Get the next available receipt number

Path
tenantId_pathstringrequired
Body
buildingIdstring(uuid)
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/receipts/GetNextReceiptNumber' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "buildingId": "fee3295a-6e55-45b0-a091-7b4de7e39de7"
  }'

Responses

OK

Body
nextCounterValueinteger(int32)
nextReceiptNumberstring
nextRefundNumberstring
Response
No response example

Create a new receipt

Request

Create a new receipt for a specific building

Path
tenantId_pathstringrequired
Body
labelstring
settledOnstring
paymentMethodinteger(int32)
Enum123
enumNames: ["Check","BankTransfer","DirectDebit"]
paymentReferencestring or null
commentstring or null
amountByLeaseIdArray of objects
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/receipts/createReceipt' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "label": "string",
    "settledOn": "string",
    "paymentMethod": 1,
    "paymentReference": "string",
    "comment": "string",
    "amountByLeaseId": [
      {
        "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
        "amount": 0.1
      }
    ]
  }'

Responses

OK

Body
idstring(uuid)
Response
No response example

Create a validated refund

Request

Create a validated refund

Path
tenantId_pathstringrequired
Body
amountnumber(double)
commentstring or null
labelstring
leaseIdsArray of strings(uuid)
paymentMethodinteger(int32)
Enum123
enumNames: ["Check","BankTransfer","DirectDebit"]
paymentReferencestring or null
renterIdstring(uuid)
settledOnstring
suspenseAccountLineAmountsArray of objects
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/receipts/CreateValidatedRefund' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "amount": 0.1,
    "comment": "string",
    "label": "string",
    "leaseIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "paymentMethod": 1,
    "paymentReference": "string",
    "renterId": "5e8fd3a6-1229-4fc6-80e4-337191896d0b",
    "settledOn": "string",
    "suspenseAccountLineAmounts": [
      {
        "amount": 0.1,
        "suspenseAccountLineId": "c1859f31-c74f-4e0d-9de1-66efbe521dc0"
      }
    ]
  }'

Responses

OK

Body
idstring(uuid)
Response
No response example

Update an existing receipt

Request

Update details of an existing receipt that is not validated

Path
tenantId_pathstringrequired
Body
idstring(uuid)
labelstring
settledOnstring
paymentMethodinteger(int32)
Enum123
enumNames: ["Check","BankTransfer","DirectDebit"]
paymentReferencestring or null
commentstring or null
amountByLeaseIdArray of objects
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/receipts/updateReceipt' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "label": "string",
    "settledOn": "string",
    "paymentMethod": 1,
    "paymentReference": "string",
    "comment": "string",
    "amountByLeaseId": [
      {
        "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
        "amount": 0.1
      }
    ]
  }'

Responses

OK

Body
object
Response
No response example

Validate a receipt before processing

Request

Validate a receipt in draft state

Path
tenantId_pathstringrequired
Body
receiptIdstring(uuid)
distributionByLeaseIdArray of objects
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/receipts/validateReceipt' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "receiptId": "4937ce52-e283-4321-b00f-c29b6dd5d0e9",
    "distributionByLeaseId": [
      {
        "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
        "distribution": [
          {
            "invoiceLineId": "01b48345-8495-4ed8-81ba-4399df639395",
            "externalBalanceRecoveryLineId": "063079d3-9bb8-4874-a230-ebf30ca4027c",
            "amount": 0.1
          }
        ]
      }
    ]
  }'

Responses

OK

Body
object
Response
No response example

Cancel a receipt

Request

Cancel a receipt that has been previously validated

Path
tenantId_pathstringrequired
Body
commentstring or null
receiptIdstring(uuid)
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/receipts/cancelReceipt' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "comment": "string",
    "receiptId": "4937ce52-e283-4321-b00f-c29b6dd5d0e9"
  }'

Responses

OK

Body
object
Response
No response example

Cancel a refund

Request

Cancel a refund that has been previously validated

Path
tenantId_pathstringrequired
Body
refundIdstring(uuid)
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/receipts/cancelRefund' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "refundId": "3324897f-393a-4bf6-b3af-0b999cbc2521"
  }'

Responses

OK

Body
object
Response
No response example

Delete a receipt

Request

Delete a receipt in draft state

Path
tenantId_pathstringrequired
Body
receiptIdstring(uuid)
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/receipts/deleteReceipt' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "receiptId": "4937ce52-e283-4321-b00f-c29b6dd5d0e9"
  }'

Responses

OK

Body
object
Response
No response example

Renter

Operations

Supplier

Operations

User

Operations