Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 2.02 KB

invoice-recipient.md

File metadata and controls

37 lines (27 loc) · 2.02 KB
Raw

Invoice Recipient

Represents a snapshot of customer data. This object stores customer data that is displayed on the invoice and that Square uses to deliver the invoice.

When you provide a customer ID for a draft invoice, Square retrieves the associated customer profile and populates the remaining InvoiceRecipient fields. You cannot update these fields after the invoice is published. Square updates the customer ID in response to a merge operation, but does not update other fields.

Structure

InvoiceRecipient

Fields

Name Type Tags Description
customerId string | undefined Optional The ID of the customer. This is the customer profile ID that
you provide when creating a draft invoice.
Constraints: Minimum Length: 1, Maximum Length: 255
givenName string | undefined Optional The recipient's given (that is, first) name.
familyName string | undefined Optional The recipient's family (that is, last) name.
emailAddress string | undefined Optional The recipient's email address.
address Address | undefined Optional Represents a postal address in a country.
For more information, see Working with Addresses.
phoneNumber string | undefined Optional The recipient's phone number.
companyName string | undefined Optional The name of the recipient's company.
taxIds InvoiceRecipientTaxIds | undefined Optional Represents the tax IDs for an invoice recipient. The country of the seller account determines
whether the corresponding tax_ids field is available for the customer. For more information,
see Invoice recipient tax IDs.

Example (as JSON)

{
  "customer_id": null,
  "address": null,
  "tax_ids": null
}