Addresses

On creation, addresses for a unit, its delivery address and invoicing address are automatically created.

Edit Unit Address

curl -i -X PATCH "https://example.ziik.io/api/units/123/addresses/1234"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
  -d "{ [...] }"

The above command returns 204 No Content on successful update.

HTTP/1.0 204 No Content

This endpoint updates an existing unit address.

HTTP Request

PATCH https://example.ziik.io/api/units/UNITID/addresses/ADDRESSID

URL Parameters

ParameterTypeDescription
UNITIDIntegerID of unit
ADDRESSIDIntegerID of unit address - must be in unit

Request Parameters

ParameterTypeRequiredDescription
use_company_addressBooleanNoWhether this address is the same as company address (only applicable for delivery and invoicing addresses)
nameStringNoA descriptive name for the address
registration_numberStringNoCompany registration number
vat_numberStringNoVAT number for company
streetStringNoStreet address
street_additionalStringNoAdditional street address information
postal_codeStringNoPostal/Zip code
cityStringNoCity name
countryStringNoName of country
phoneStringNoMain phone number
emailStringNoMain contact email
commentsStringNoComments for the address - freetext

Permissions Required

  • Edit permission to the unit
Contributors: Christian Gerdes