SalesInvoiceRecipient.md

SalesInvoiceRecipient

Fields

Field	Type	Required	Description	Example
type	SalesInvoiceRecipientType	✔️	The type of recipient, either consumer or business. This will determine what further fields are required on the recipient object.	consumer
title	JsonNullable<String>	➖	The title of the consumer type recipient, for example Mr. or Mrs..	Mrs.
givenName	JsonNullable<String>	➖	The given name (first name) of the consumer type recipient should be at least two characters and cannot contain only numbers.	Jane
familyName	JsonNullable<String>	➖	The given name (last name) of the consumer type recipient should be at least two characters and cannot contain only numbers.	Doe
organizationName	JsonNullable<String>	➖	The trading name of the business type recipient.	Organization Corp.
organizationNumber	JsonNullable<String>	➖	The Chamber of Commerce number of the organization for a business type recipient. Either this or vatNumber has to be provided.	12345678
vatNumber	JsonNullable<String>	➖	The VAT number of the organization for a business type recipient. Either this or organizationNumber has to be provided.	NL123456789B01
email	String	✔️	The email address of the recipient. If the domain contains non-ASCII characters, encode it as Punycode per RFC 3492.	example@email.com
phone	JsonNullable<String>	➖	The phone number of the recipient.	+0123456789
streetAndNumber	String	✔️	A street and street number.	Keizersgracht 126
streetAdditional	JsonNullable<String>	➖	Any additional addressing details, for example an apartment number.	4th floor
postalCode	String	✔️	A postal code.	5678AB
city	String	✔️	The recipient's city.	Amsterdam
region	JsonNullable<String>	➖	The recipient's region.	Noord-Holland
country	String	✔️	A country code in ISO 3166-1 alpha-2 format.	NL
locale	SalesInvoiceRecipientLocale	✔️	The locale for the recipient, to be used for translations in PDF generation and payment pages.	nl_NL