v2

latestSwagger 2.02026-08-0138140265.1 KB

LegalEntities

Update LegalEntity

Update a specific LegalEntity.

patch/legal_entities/{id}

Path parameters

idinteger required

legal_entity id

Request body

idinteger

The Storecove assigned id for the LegalEntity.

party_namestring

The name of the company.

line1string

The first address line.

line2string

The second address line, if applicable

citystring

The city.

zipstring

The zipcode.

countystring

County, if applicable

country'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'XK' | 'XI'

An ISO 3166-1 alpha-2 country code.

registration_authority_namestring

The name of the authority that issued the legal registration identifier. Used for UAE PINT-AE BTAE-11.

passport_issuing_countrystring

The ISO 3166-1 alpha-2 country code, or Peppol extension 1A, for the authority that issued the passport. Used for UAE PINT-AE BTAE-19.

tenant_idstring

The id of the tenant, to be used in case of multi-tenant solutions. This property will included in webhook events.

publicboolean

Whether or not this LegalEntity is public. Public means it will be listed in the PEPPOL directory at https://directory.peppol.eu/ which is normally what you want. If you have a good reason to not want the LegalEntity listed, provide false. This property is ignored when for country SG, where it is always true.

advertisementsstring[]

A list of document groups to advertise. ++++

<ul> <li> invoice Gives Invoice and where applicable CreditNote under the Billing process. </li> <li> invoice_response Gives InvoiceResponse under the Invoice Response process. </li> <li> selfbilling Gives Invoice and where applicable CreditNote under the Selfbilling process. </li> <li> order Gives Order under the Order Only process. </li> <li> ordering Gives Order and OrderResponse under the Ordering process. </li> <li> advanced_ordering Gives Order, AdvancedOrderResponse, OrderChange and OrderCancellation under the Advanced Ordering process. </li> <li> despatch_advice Gives DespatchAdvice under the Despatch Advice process. </li> <li> advanced_ordering_sg_order_balance Gives OrderBalance under the Advanced Ordering SG Order Balance process. </li> <li> remittance_advice Gives RemittanceAdvice (DBNAlliance only). </li> <li> pidx_invoicing_ordering Gives PIDX Invoice, InvoiceResponse, OrderChange, OrderCreate and OrderResponse (DBNAlliance only). </li></ul> ++++

third_party_usernamestring

The username to use to authenticate to a system through which to send the document, or to obtain tax authority approval to send it. This field is currently relevant only for India and mandatory when creating an IN LegalEntity.

third_party_passwordstring

The password to use to authenticate to a system through which to send the document, or to obtain tax authority approval to send it. This field is currently relevant only for India and mandatory when creating an IN LegalEntity.

smart_inboxstring

DEPRECATED. Use the <<_openapi_receiveddocuments_resource>> endpoint. The email address of the Smart Inbox for this LegalEntity.

acts_as_senderboolean

Whether or not this LegalEntity can act as a sender of documents.

acts_as_receiverboolean

Whether or not this LegalEntity can act as a receiver of documents. If not, no identifiers will be provioned on any exchange network.

tax_registeredboolean

Whether or not this LegalEntity is tax registered. This influences the validation of the data presented when sending documents.

override_own_credentialsboolean

If true, Storecove will use default credentials/signing artifacts even if specific ones are configured for this LegalEntity. Defaults to false.

classification_codestring

The classification code for this LegalEntity. For Malaysia, this is the MSIC code. It is mandatory for MY legal entities.

Response

Success