younifyd
Menu

Get Business Entity

Fetch a business entity

GET/business_entities/{business_entity_id}

Use it in a workflow

  1. Add a step and choose the Recurly connector.
  2. Pick the Get Business Entity action (under business_entities).
  3. Fill in the fields below, then reference the result from later steps as {{getBusinessEntity.response.data}}.

Request

Path parameters

business_entity_idstringrequired

Business Entity ID. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-entity1`.

Response

Returns 200 with an object. Read it in later steps with {{getBusinessEntity.response.data.<field>}}.

idstring
objectstring
codestring

The entity code of the business entity.

namestring

This name describes your business entity and will appear on the invoice.

invoice_display_addressobject
phonestring
street1string
street2string
citystring
regionstring

State or province.

postal_codestring

Zip or postal code.

countrystring

Country, 2-letter ISO 3166-1 alpha-2 code.

geo_codestring

Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.

tax_addressobject
phonestring
street1string
street2string
citystring
regionstring

State or province.

postal_codestring

Zip or postal code.

countrystring

Country, 2-letter ISO 3166-1 alpha-2 code.

geo_codestring

Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.

origin_tax_address_sourcestring

The source of the address that will be used as the origin in determining taxes. Available only when the site is on an Elite plan. A value of "origin" refers to the "Business entity tax address". A value of "destination" refers to the "Customer tax address".

One oforigindestinationDefault "origin"

destination_tax_address_sourcestring

The source of the address that will be used as the destinaion in determining taxes. Available only when the site is on an Elite plan. A value of "destination" refers to the "Customer tax address". A value of "origin" refers to the "Business entity tax address".

One ofdestinationoriginDefault "destination"

default_vat_numberstring

VAT number for the customer used on the invoice.

default_registration_numberstring

Registration number for the customer used on the invoice.

subscriber_location_countriesarray<string>

List of countries for which the business entity will be used.

default_liability_gl_account_idstring

The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

default_revenue_gl_account_idstring

The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

created_atstring (date-time)
updated_atstring (date-time)
json
{
  "id": "string",
  "object": "string",
  "code": "string",
  "name": "string",
  "invoice_display_address": {
    "phone": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "postal_code": "string",
    "country": "string",
    "geo_code": "string"
  },
  "tax_address": {
    "phone": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "postal_code": "string",
    "country": "string",
    "geo_code": "string"
  },
  "origin_tax_address_source": "origin",
  "destination_tax_address_source": "destination",
  "default_vat_number": "string",
  "default_registration_number": "string",
  "subscriber_location_countries": [
    "string"
  ],
  "default_liability_gl_account_id": "string"
}

Need more? See the Recurly guide for connection setup and behaviour shared by every action.