v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Customers

Update customer tax info

patch/v3/customers/{id}/tax-info

Path parameters

idstring required

Example:123e4567-e89b-12d3-a456-426614174000

Customer Id

Request body

vatIdstring

VAT identifier

einstring

EIN identifier

isTaxExemptboolean

Whether customer is tax exempt

Example request

{
  "vatId": "DE123456789",
  "ein": "12-3456789"
}

Response

Updated customer tax info

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Acme Inc.",
    "parentCustomerId": "123e4567-e89b-12d3-a456-426614174000",
    "defaultCurrency": "USD",
    "primaryBillingContactName": "John Doe",
    "primaryBillingContactEmail": "john.doe@example.com",
    "secondaryBillingContacts": [
      "jane.doe@example.com",
      "jim.doe@example.com"
    ],
    "billingAddress": {
      "externalId": "10",
      "city": "New York",
      "state": "NY",
      "country": "US",
      "postalCode": "10001",
      "line1": "123 Main St",
      "line2": "Apt 1",
      "addressee": "John Doe"
    },
    "shippingAddress": {
      "externalId": "10",
      "city": "New York",
      "state": "NY",
      "country": "US",
      "postalCode": "10001",
      "line1": "123 Main St",
      "line2": "Apt 1",
      "addressee": "John Doe"
    },
    "externalIds": [
      {
        "type": "NETSUITE",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "lastUpdatedAt": "2024-01-01T00:00:00.000Z",
    "autoCharge": true,
    "customerTaxInfo": {
      "vatId": "DE123456789",
      "ein": "12-3456789"
    }
  }
}