LegalEntity

Retrieves the collection of LegalEntity resources.

Retrieves the collection of LegalEntity resources.

SecurityBearer
Request
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

identifierValue
string
identifierValue[]
Array of strings
registeredName
string
registeredName[]
Array of strings
sortBy[createdAt]
string
Enum: "asc" "desc"
sortBy[registeredName]
string
Enum: "asc" "desc"
sortBy[identifierScheme]
string
Enum: "asc" "desc"
sortBy[identifierValue]
string
Enum: "asc" "desc"
Responses
200

LegalEntity collection

get/legal-entities
Request samples 
Response samples 
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}
Creates a LegalEntity resource.
Creates a LegalEntity resource.


SecurityBearer 
Request 
Request Body schema: 
required
The new LegalEntity resource


registeredName
string
Name used to register the End User in the business registry of the jurisdiction where it is legally based.


 
country
string  = 2 characters 
Country code ISO 3166-1 alpha-2 codes


 
address
string or null
Legal entity address


 
city
string or null
Legal entity city


 
stateOrProvince
string or null
Legal entity state or province


 
zipCode
string or null
Legal entity zip code


 
identifierScheme
string
 Default:  "iso6523-actorid-upis"
The participant identifier scheme


 
identifierValue
string
The participant identifier built as per the OpenPeppol normative version of the code list


 
receivedDocumentNotificationEmails
Array of strings or null
The list of email addresses where a notification is sent for each received document


 
Responses 
201
LegalEntity resource created


400
Invalid input


422
Unprocessable entity


post/legal-entities
Request samples 
{
  • "registeredName": "string",
  • "country": "st",
  • "address": "string",
  • "city": "string",
  • "stateOrProvince": "string",
  • "zipCode": "string",
  • "identifierScheme": "iso6523-actorid-upis",
  • "identifierValue": "string",
  • "receivedDocumentNotificationEmails": [
    ]
}
Response samples 
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "uuid": "string",
  • "registeredName": "string",
  • "country": "string",
  • "address": "string",
  • "city": "string",
  • "stateOrProvince": "string",
  • "zipCode": "string",
  • "identifierScheme": "iso6523-actorid-upis",
  • "identifierValue": "string",
  • "receivedDocumentNotificationEmails": [
    ],
  • "smpEnabled": true,
  • "createdAt": "string",
  • "updatedAt": "string"
}
Retrieves a LegalEntity resource.
Retrieves a LegalEntity resource.


SecurityBearer 
Request 
path Parameters
uuid
required
string
Resource identifier


 
Responses 
200
LegalEntity resource


404
Resource not found


get/legal-entities/{uuid}
Request samples 
Response samples 
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "uuid": "string",
  • "registeredName": "string",
  • "country": "string",
  • "address": "string",
  • "city": "string",
  • "stateOrProvince": "string",
  • "zipCode": "string",
  • "identifierScheme": "iso6523-actorid-upis",
  • "identifierValue": "string",
  • "receivedDocumentNotificationEmails": [
    ],
  • "smpEnabled": true,
  • "createdAt": "string",
  • "updatedAt": "string"
}
Replaces the LegalEntity resource.
Replaces the LegalEntity resource.


SecurityBearer 
Request 
path Parameters
uuid
required
string
Resource identifier


 
Request Body schema: 
required
The updated LegalEntity resource


uuid
string <uuid> 
 
ownerId
integer
Owner ID.


 
registeredName
string
 
country
string
 
address
string or null
 
city
string or null
 
stateOrProvince
string or null
 
zipCode
string or null
 
identifierScheme
string
 
identifierValue
string
 
smpEnabled
boolean
 
receivedDocumentNotificationEmails
string or null
 
createdAt
string <date-time> 
 
Array of objects (PeppolMessage.jsonld) 
ORM\OneToMany(targetEntity="App\Entity\PeppolMessage", mappedBy="legalEntity")


 
Responses 
200
LegalEntity resource updated


400
Invalid input


404
Resource not found


422
Unprocessable entity


put/legal-entities/{uuid}
Request samples 
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "ownerId": 0,
  • "registeredName": "string",
  • "country": "string",
  • "address": "string",
  • "city": "string",
  • "stateOrProvince": "string",
  • "zipCode": "string",
  • "identifierScheme": "string",
  • "identifierValue": "string",
  • "smpEnabled": true,
  • "receivedDocumentNotificationEmails": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "peppolMessages": [
    ]
}
Response samples 
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "uuid": "string",
  • "registeredName": "string",
  • "country": "string",
  • "address": "string",
  • "city": "string",
  • "stateOrProvince": "string",
  • "zipCode": "string",
  • "identifierScheme": "iso6523-actorid-upis",
  • "identifierValue": "string",
  • "receivedDocumentNotificationEmails": [
    ],
  • "smpEnabled": true,
  • "createdAt": "string",
  • "updatedAt": "string"
}
Removes the LegalEntity resource.
Removes the LegalEntity resource.


SecurityBearer 
Request 
path Parameters
uuid
required
string
Resource identifier


 
Responses 
204
LegalEntity resource deleted


404
Resource not found


delete/legal-entities/{uuid}
Request samples 
Read the SMP records for the LegalEntity resource
Retrieves a LegalEntity resource.


SecurityBearer 
Request 
path Parameters
uuid
required
string
Resource identifier


 
Responses 
200
LegalEntity resource


404
Resource not found


get/legal-entities/{uuid}/smp
Request samples 
Response samples 
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "enabled": true,
  • "capabilities": [
    ]
}
Manage the SMP records for the LegalEntity resource
Replaces the LegalEntity resource.


SecurityBearer 
Request 
path Parameters
uuid
required
string
Resource identifier


 
Request Body schema: 
required
The updated LegalEntity resource


enabled
boolean
Setting enabled to true will write the record into the SMP, with false the record will be deleted from the SMP.


 
Array of objects (LegalEntitySMPCapabilityInput.jsonld) 
The list of documents and processes this legal entity can manage, stored into the SMP.


 
Responses 
200
LegalEntity resource updated


400
Invalid input


404
Resource not found


422
Unprocessable entity


put/legal-entities/{uuid}/smp
Request samples 
{
  • "enabled": true,
  • "capabilities": [
    ]
}
Response samples 
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "enabled": true,
  • "capabilities": [
    ]
}