LegalEntity

Retrieve the collection of LegalEntity resources.

Retrieve the collection of LegalEntity resources.

SecurityBearer
Request
query Parameters
page
integer
Default: 1

The collection page number

Responses
200

LegalEntity collection

400

Bad Request

401

Unauthorized

404

Resource not Found

get/legal-entities
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create a LegalEntity resource.
Create a LegalEntity resource.


SecurityBearer 
Request 
Request Body schema: application/json
required
The new LegalEntity resource


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


 
nip
required
string
Legal entity NIP.


 
email
required
string <email> 
Legal entity email.


 
http://schema.org/email
url
string or null
Legal entity url.


 
addressLine1
required
string
Legal entity address line 1.


 
addressLine2
required
string
Legal entity address line 2.


 
postcode
required
string
Legal entity postcode.


 
province
string or null
Legal entity province.


 
city
required
string
Legal entity city.


 
countryIso2
required
string  = 2 characters 
Country code ISO 3166-1 alpha-2 codes.


 
Responses 
201
LegalEntity resource created


400
Invalid input


422
Unprocessable entity


post/legal-entities
Request samples 
application/json
{
  • "name": "Company name",
  • "nip": "0000000000",
  • "email": "user@example.com",
  • "url": "company.url",
  • "addressLine1": "ul. Street",
  • "addressLine2": "10/1",
  • "postcode": "00-000",
  • "province": "Province",
  • "city": "City",
  • "countryIso2": "PL"
}
Response samples 
application/json
{
  • "uuid": "string",
  • "status": "pending",
  • "name": "string",
  • "nip": "string",
  • "email": "string",
  • "url": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "postcode": "string",
  • "province": "string",
  • "city": "string",
  • "countryIso2": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "authFlowUUID": "string",
  • "authFlowStatus": "new",
  • "authFlowIsValid": true,
  • "authFlowUrl": "string",
  • "authFlowDeadline": "string",
  • "authFlowCreatedAt": "string",
  • "authFlowUpdatedAt": "string",
  • "isAuthCyclerRunning": true,
  • "isInvoiceSenderRunning": true,
  • "isInvoiceReceiverRunning": true,
  • "isInvoiceSyncRunning": true,
  • "customer": {
    }
}
Changing status legal entity to block
Changing status legal entity to block


SecurityBearer 
Request 
path Parameters
legalEntity
required
string
Legal Entity UUID


 
Request Body schema: application/json
required
The new LegalEntity resource


any
 
Responses 
201
LegalEntity resource created


400
Invalid input


422
Unprocessable entity


post/legal-entities/{legalEntity}/block
Request samples 
application/json
null
Response samples 
application/json
{
  • "uuid": "string",
  • "status": "pending",
  • "name": "string",
  • "nip": "string",
  • "email": "string",
  • "url": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "postcode": "string",
  • "province": "string",
  • "city": "string",
  • "countryIso2": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "authFlowUUID": "string",
  • "authFlowStatus": "new",
  • "authFlowIsValid": true,
  • "authFlowUrl": "string",
  • "authFlowDeadline": "string",
  • "authFlowCreatedAt": "string",
  • "authFlowUpdatedAt": "string",
  • "isAuthCyclerRunning": true,
  • "isInvoiceSenderRunning": true,
  • "isInvoiceReceiverRunning": true,
  • "isInvoiceSyncRunning": true,
  • "customer": {
    }
}
Retrieve the collection of LegalEntity resources.
Retrieve the collection of LegalEntity resources.


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 
application/json
{
  • "uuid": "string",
  • "status": "pending",
  • "name": "string",
  • "nip": "string",
  • "email": "string",
  • "url": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "postcode": "string",
  • "province": "string",
  • "city": "string",
  • "countryIso2": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "authFlowUUID": "string",
  • "authFlowStatus": "new",
  • "authFlowIsValid": true,
  • "authFlowUrl": "string",
  • "authFlowDeadline": "string",
  • "authFlowCreatedAt": "string",
  • "authFlowUpdatedAt": "string",
  • "isAuthCyclerRunning": true,
  • "isInvoiceSenderRunning": true,
  • "isInvoiceReceiverRunning": true,
  • "isInvoiceSyncRunning": true,
  • "customer": {
    }
}
Replace the LegalEntity resource.
Replace the LegalEntity resource.


SecurityBearer 
Request 
path Parameters
uuid
required
string
Resource identifier


 
Request Body schema: application/json
required
The updated LegalEntity resource


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


 
nip
required
string
Legal entity NIP.


 
email
required
string <email> 
Legal entity email.


 
http://schema.org/email
url
string or null
Legal entity url.


 
addressLine1
required
string
Legal entity address line 1.


 
addressLine2
required
string
Legal entity address line 2.


 
postcode
required
string
Legal entity postcode.


 
province
string or null
Legal entity province.


 
city
required
string
Legal entity city.


 
countryIso2
required
string  = 2 characters 
Country code ISO 3166-1 alpha-2 codes.


 
Responses 
200
LegalEntity resource updated


400
Invalid input


404
Resource not found


422
Unprocessable entity


put/legal-entities/{uuid}
Request samples 
application/json
{
  • "name": "Company name",
  • "nip": "0000000000",
  • "email": "user@example.com",
  • "url": "company.url",
  • "addressLine1": "ul. Street",
  • "addressLine2": "10/1",
  • "postcode": "00-000",
  • "province": "Province",
  • "city": "City",
  • "countryIso2": "PL"
}
Response samples 
application/json
{
  • "uuid": "string",
  • "status": "pending",
  • "name": "string",
  • "nip": "string",
  • "email": "string",
  • "url": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "postcode": "string",
  • "province": "string",
  • "city": "string",
  • "countryIso2": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "authFlowUUID": "string",
  • "authFlowStatus": "new",
  • "authFlowIsValid": true,
  • "authFlowUrl": "string",
  • "authFlowDeadline": "string",
  • "authFlowCreatedAt": "string",
  • "authFlowUpdatedAt": "string",
  • "isAuthCyclerRunning": true,
  • "isInvoiceSenderRunning": true,
  • "isInvoiceReceiverRunning": true,
  • "isInvoiceSyncRunning": true,
  • "customer": {
    }
}
Validate nips.
Validate nips.


SecurityBearer 
Request 
Request Body schema: application/json
optional
nips
Array of strings
 
Responses 
200
LegalEntity resource created


400
Bad Request


403
Forbidden


422
Unprocessable entity


post/nip/validate
Request samples 
application/json
{
  • "nips": [
    ]
}
Response samples 
application/json
{
  • "nips": [
    ]
}