Retrieve address

get https://api.nitrobox.io/v2/customers/{ident}/addresses/{addressIdent}

Get a specific Address of customer by ident.

Responses

Response body

object

firstname

string

length between 0 and 255

First name of recipient.
Size must be between 0 and 255.

lastname

string

length between 0 and 255

Last name of recipient.
Size must be between 0 and 255.

gender

string

Recipient's gender.
Must be one of:

MALE

FEMALE

OTHER

NOTSET

addressType

string

required

Cannot be amended after the initial POST.
Must not be null.
Must be one of:

INVOICE

SHIPPING

academicTitle

string

length between 0 and 255

Size must be between 0 and 255.

addressAddition

string

length between 0 and 255

Optional additional address information.
Size must be between 0 and 255.

agencyProfessionTitle

string

length between 0 and 255

Agency Profession Title.
Size must be between 0 and 255.

city

string

length between 0 and 255

City.
Size must be between 0 and 255.

company

string

length between 0 and 255

Company name.
Size must be between 0 and 255.

country

string

required

Country code for country of address. Uses Alpha-2 or Alpha3 code (ISO 3166): https://www.iban.com/country-codes.
Must not be null.

department

string

length between 0 and 255

Department within a company.
Size must be between 0 and 255.

string

length between 0 and 255

Recipient's email. It becomes mandatory for addresses of addressType INVOICE and preferredDocumentDelivery EMAIL.
Size must be between 0 and 255.

postOfficeBox

string

length between 0 and 255

Number of post office box.
Size must be between 0 and 255.

zip

string

length between 0 and 10

Postcode.
Size must be between 0 and 10.

street

string

length between 0 and 255

Name of street.
Size must be between 0 and 255.

streetNo

string

length between 0 and 255

Street Number.
Size must be between 0 and 255.

vatId

string

length between 0 and 20

Also known as VAT identification number (VATIN). An identifier used by countries for Value Added Tax purposes to identify legal entities, especially in the EU.
Size must be between 0 and 20.

taxNumber

string

length between 0 and 32

The taxNumber is the local country tax number given to a legal entity by their tax authority such as the German Steuernummer or Italian Codice Fiscale.
Size must be between 0 and 32.

state

string

length between 0 and 255

State.
Size must be between 0 and 255.

stateCode

string

length between 0 and 255

State code. ISO 3166-2 subdivision code.
Size must be between 0 and 255.

preferredDocumentDelivery

string

Defaults to NONE

Defines the preferred way of delivering documents to this customer. Only used for Addresses of Type INVOICE. When set to EMAIL and addressType is INVOICE, the field email must be filled.
Must be one of:

LETTER

NONE

properties

array of objects

required

Array of properties assigned to the specific address.
Must not be null.

properties*

object

propertyIdent

string

required

length between 1 and 100

Key of the property.
Must not be blank.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

propertyValue

string

required

length between 0 and 255

Value of the property.
Must not be null.
Size must be between 0 and 255.

validationStatus

string

Status of address validation if required by configured tax provider.
Must be one of:

TAXABLE

NON_TAXABLE

VALIDATION_PENDING

VALIDATION_NOT_REQUIRED

NOT_VALIDATED

VALIDATION_FAILED

addressId

int64

Is set by Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.

createdAt

date-time

Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).

lastModifiedAt

date-time

Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).

debtorId

int64

Is set by Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.

tenantId

int64

Is set by Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.

addressIdent

string

length between 1 and 100

Unique external reference. If not provided NBX will auto generate a UUID.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

eInvoicingParameters

object

Provides information needed to handle e-invoicing.

recipientCodeType

string

For which e-invoicing scheme the following recipient code is relevant.
Must be one of:

FATURA_PA_CODICE_DESTINATARIO

Fatura PA Codice Destinatario

recipientCode

string

length between 0 and 255

The recipient code used in the underlying network of the recipientCodeType.
Size must be between 0 and 255.

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.nitrobox.io/v2/customers/ident/addresses/addressIdent \
3
     --header 'accept: application/json'

Choose an example:

application/json

200Standard response for successful HTTP requests.

4XXerror response for all http error codes in range 4XX

5XXerror response for all http error codes in range 5XX