Customers

Update a Billing Address

Partially update a Billing Address

patch/billing_addresses/public/{billingAddressId}

Request

Path parameters

billingAddressIdinteger required

The billing address id

Request body

address1string

The street address

address2string nullable

Unit

citystring

The city of the address

countrystring

The three character country abbreviation

postal_codestring

The postal code for the address

statestring

The two character state abbreviation

erp_codestring

The unique identifier for this address record in the ERP

Example request

{
  "address1": "137 Portland St.",
  "address2": "Unit 1",
  "city": "Boston",
  "country": "USA",
  "postal_code": "02114",
  "state": "MA",
  "erp_code": "B1234"
}

Response

Successful response

country_codestring nullable
credit_cards_enabledboolean
metadataobject nullable
namestring

(Required) The name of the account

createdstring
credit_linenumber nullable

credit line (dollars)

erp_codestring nullable

The ERP code of the account

idinteger

the ID of the account

notesstring nullable

Account notes

payment_termsstring nullable

Payment terms; required if payment_terms_period are included

payment_terms_periodinteger nullable

Payment terms period in days; required if payment_terms are included, but can be null

phonestring nullable

Account phone number

phone_extstring nullable

Account phone number extension

purchase_orders_enabledboolean

When true this account can check out with a purchase order

tax_exemptboolean

When true, sales tax will not be added to a quote

tax_ratenumber nullable

Sales tax rate for this account

typestring

Type of account, either customer or vendor

urlstring nullable

Example response

{
  "billing_addresses": [
    {
      "address1": "1 City Hall Sq.",
      "city": "Boston",
      "state": "MA",
      "postal_code": "02114",
      "country": "USA",
      "erp_code": "B1234"
    }
  ],
  "name": "Paperless Parts, Inc.",
  "created": "2020-08-25T18:00:53+00:00",
  "credit_line": 10000,
  "erp_code": "PPI",
  "id": 17,
  "payment_terms": "Net 30",
  "payment_terms_period": 30,
  "phone": "6176354500",
  "purchase_orders_enabled": true,
  "sold_to_address": {
    "address1": "1 City Hall Sq.",
    "city": "Boston",
    "state": "MA",
    "postal_code": "02114",
    "country": "USA",
    "erp_code": "B1234"
  },
  "tax_exempt": true,
  "tax_rate": 6.25,
  "type": "customer",
  "url": "https://www.paperlessparts.com"
}

Changes

No recorded changes to this operation across all 1 revision of this API.