Patching Entities

Updating Entity information: through the PATCH endpoint

To easily update a variety of properties pertaining to your entities, you can use our PATCH endpoint. The sent data will simply be a collection of the properties you wish to update and their new value.

PATCH Existing Entities Endpoint Details

• HTTP Method: PATCH
• Endpoint: /v1/einvoices/registrations/{registrationID}
• Body:
  Patch Entity

  {
      "CompanyName": "Tech Corp",
      "CommercialName": "Tech Corp",
      "TaxDeductable": true,
      "TaxLiable": true,
      "IBAN": "BE1234567890",
      "BIC": "BBRUBEBB",
      "Mobile": "+320499999999",
      "Phone": "3224609999",
      "Email": "[email protected]",
      "ContactFirstName": "Jane",
      "ContactLastName": "Doe",
      "Language": "EN",
      "Street": "Tech street",
      "StreetNumber": "2",
      "Box": "Floor 2",
      "Zipcode": "1000",
      "City": "Tech City",
      "CountryCode": "BE"
  }

Additional info:

• The body of your request may contain 1 or many properties that you wish to patch for the given entity.
• If you do not want to patch all properties, do not include them in the patch (do not send it as empty).
• Only the properties mentioned in the body can be patched. Others are not supported.
• When success, the status code 200 is returned.
• If you want to check the result of a Patch, you can launch a GET command.

What if Entity Data have to be edited, and Patch via API is not Supported ?

If other data need to be modified (no patch via API possible), this can be done in the MyBillit user interface by the partner.

Examples:

• Modify PDF Template (e.g. upload logo)