v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
organizations

Update an organization

Update details about an existing organization. The currently signed-in user must have the ADMINISTRATOR user role in the BILL organization to perform this operation.

See Organizations and Users in the Guides section for more information, sample requests, and responses.

patch/v3/organizations/{organizationId}

Path parameters

organizationIdstring required

BILL-generated ID of the organization. The value begins with 008.

Example:{{organization_id}}

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}
devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Request body

namestring

Organization name

phonestring

Organization phone number

taxIdstring

Organization tax ID. This value is required by the IRS for tax purposes.

taxIdType'EIN' | 'SSN'

Organization tax ID type

industrystring

Organization industry

businessCategory'CORPORATION' | 'LLC' | 'NON_PROFIT' | 'GOVERNMENT' | 'SOLE_PROPRIETOR' | 'INDIVIDUAL' | 'TRUST' | 'UNKNOWN'

Organization business category

accountType'BUSINESS' | 'CONTRACTOR' | 'EMPLOYEE_OR_INDIVIDUAL' | 'OTHER' | 'CONSUMER'

Organization account type

Example request

{
  "address": {
    "zipOrPostalCode": "95002"
  }
}

Response

Update an organization response

idstring

BILL-generated ID of the organization. The value begins with 008.

archivedboolean

Set as true if the organization is archived. You cannot archive an organization with the API.

namestring

Organization name

phonestring

Organization phone number

taxIdstring

Organization tax ID. This value is required by the IRS for tax purposes.

taxIdType'EIN' | 'SSN' | 'UNDEFINED'

Organization tax ID type.

industrystring

Organization industry

businessCategory'UNDEFINED' | 'CORPORATION' | 'LLC' | 'NON_PROFIT' | 'GOVERNMENT' | 'SOLE_PROPRIETOR' | 'INDIVIDUAL' | 'TRUST' | 'UNKNOWN'

Organization business category.

accountType'BUSINESS' | 'CONTRACTOR' | 'EMPLOYEE_OR_INDIVIDUAL' | 'OTHER' | 'CONSUMER' | 'UNDEFINED'

Organization account type.

partnerNamestring

Partner name.

This field is available only when select BILL partners create an organization. Partner name is part of the information that BILL uses to identify partners.

createdTimestring date-time

Created date and time

updatedTimestring date-time

Updated date and time