younifyd
Menu

List Business Entities

List business entities

GET/business_entities

Use it in a workflow

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

Fields

baseUrlstring

The API host this action calls. Choose one, or pick Custom to enter your own.

One ofhttps://v3.recurly.comhttps://v3.eu.recurly.com__custom__Default "https://v3.recurly.com"

baseUrlCustomstring
forwardAllHeadersboolean

If enabled, all headers from the incoming request will be forwarded. Additional headers below will override forwarded ones.

Default false

headerskeyvalue

Extra HTTP headers to include, beyond what this action already declares. These override forwarded or declared headers with the same name.

queryParamskeyvalue

Extra URL query parameters to include, beyond what this action already declares. These override declared query parameters with the same name.

Response

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

objectstring

Will always be List.

has_moreboolean

Indicates there are more results on subsequent pages.

nextstring

Path to subsequent page of results.

dataarray<object>
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_addressobject8 fields
tax_addressobject8 fields
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
{
  "object": "string",
  "has_more": false,
  "next": "string",
  "data": [
    {
      "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.