ApiConfiguration

Retrieves the collection of ApiConfiguration resources.

SecurityBearer
Request
query Parameters
businessRegistryConfigurations.fiscalId
string
businessRegistryConfigurations.fiscalId[]
Array of strings
Responses
200

ApiConfiguration collection response

get/api-configurations
Request samples
Response samples
[
  • {
    }
]

Creates a ApiConfiguration resource.

SecurityBearer
Request
Request Body schema:

The new ApiConfiguration resource

event
string

The event code can be one of supplier-invoice, customer-invoice, customer-notification, legal-storage-missing-vat, legal-storage-receipt

target_url
string

Full URL to your endpoint

authentication_type
string

Authentication type can be one of query, header

authentication_key
string

The authentication key, in case of type header used as Authorization: authentication_key authentication_token

authentication_token
string

The authentication token, in case of type header used as Authorization: authentication_key authentication_token

Responses
201

ApiConfiguration resource created

400

Invalid input

404

Resource not found

post/api-configurations
Request samples
{
  • "event": "string",
  • "target_url": "string",
  • "authentication_type": "string",
  • "authentication_key": "string",
  • "authentication_token": "string"
}
Response samples
{
  • "uuid": "string",
  • "event": "string",
  • "target_url": "string",
  • "authentication_type": "string",
  • "authentication_key": "string",
  • "authentication_token": "string",
  • "business_registry_configurations": [
    ]
}

Removes the ApiConfiguration resource.

SecurityBearer
Request
path Parameters
id
required
string
Responses
204

ApiConfiguration resource deleted

404

Resource not found

delete/api-configurations/{id}
Request samples

Retrieves a ApiConfiguration resource.

SecurityBearer
Request
path Parameters
id
required
string
Responses
200

ApiConfiguration resource response

404

Resource not found

get/api-configurations/{id}
Request samples
Response samples
{
  • "uuid": "string",
  • "event": "string",
  • "target_url": "string",
  • "authentication_type": "string",
  • "authentication_key": "string",
  • "authentication_token": "string",
  • "business_registry_configurations": [
    ]
}

Replaces the ApiConfiguration resource.

SecurityBearer
Request
path Parameters
id
required
string
Request Body schema:

The updated ApiConfiguration resource

event
string

The event code can be one of supplier-invoice, customer-invoice, customer-notification, legal-storage-missing-vat, legal-storage-receipt

target_url
string

Full URL to your endpoint

authentication_type
string

Authentication type can be one of query, header

authentication_key
string

The authentication key, in case of type header used as Authorization: authentication_key authentication_token

authentication_token
string

The authentication token, in case of type header used as Authorization: authentication_key authentication_token

Responses
200

ApiConfiguration resource updated

400

Invalid input

404

Resource not found

put/api-configurations/{id}
Request samples
{
  • "event": "string",
  • "target_url": "string",
  • "authentication_type": "string",
  • "authentication_key": "string",
  • "authentication_token": "string"
}
Response samples
{
  • "uuid": "string",
  • "event": "string",
  • "target_url": "string",
  • "authentication_type": "string",
  • "authentication_key": "string",
  • "authentication_token": "string",
  • "business_registry_configurations": [
    ]
}