Skip to content

Overview

fiskaly Logo
API docs by Redocly

fiskaly management API (0.12.0)

Download OpenAPI specification:

fiskaly GmbH: info@fiskaly.com URL: https://fiskaly.com

Imprint: fiskaly.com/impressum | Privacy Policy: fiskaly.com/datenschutz

Introduction

The fiskaly management API is a RESTful API that can be used for automatizing concerns within the fiskaly dashboard.

Base URL: https://dashboard.fiskaly.com/api/v0

Versioning

Our API follows Semantic Versioning.

That means, given a version number MAJOR.MINOR.PATCH, we increment the:

  • MAJOR version when we make incompatible API changes,
  • MINOR version when we add functionality in a backwards-compatible manner, and
  • PATCH version when we make backwards-compatible bug fixes.

The current MAJOR version 0 is reflected in the APIs base URL: /api/v0.

Changelog

  • 0.12.0 (2022-01-05):
  • 0.11.0 (2021-06-25):
  • 0.10.0 (2021-05-10):
    • Performance optimization for listOrganizations
    • Added query parameters for listUsers
  • 0.9.1:
    • Performance optimization for API Key requests.
  • 0.9.0:
    • Added possibility to create main organizations in LIVE mode if the billing_options.bill_to_organization is set, the set organization is also in LIVE mode and a token with env:LIVE is present.
    • Added created_by_user field on multiple responses.
    • Fixed edge case where setting the billing_options.bill_to_organization for a MANAGED_ORGANIZATION raised an error.
  • 0.8.0:
    • Added new endpoint to delete a user from an organization.
    • Fixed the invite endpoint to invite new users to an organization.
  • 0.7.1:
  • 0.7.0:
    • Added display_name field to organizations and managed_organizations.
    • Added List Organizations to list all organizations.
  • 0.6.1:
    • Fixed authentication with email and password.
    • Fixed patch endpoint of organization, allowing the managed_by_organization field to be set if it is the same value as the current organization state.
  • 0.6.0:
  • 0.5.0:
    • Added validation of all country_code fields.
    • Added new UserAuthentication that allows for authentication via User credentials (i.e. E-Mail and password).
  • 0.4.0:
    • Added additional access_token_claims property in the Retrieve token operation's endpoint.
  • 0.3.0:
    • WARNING: Changed all update endpoints to use the HTTP PATCH method, instead of PUT. Until the next major API update (i.e. 1.0.0) PUT will still work as well. Be sure to update your implementation as soon as possible, as this will be a breaking change!
  • 0.2.0:
    • Added separate body for API keys and managed API keys respectively (this affects Create API Key and Retrieve API Key).
    • Added type MANAGED_API_KEY to API Keys.
    • Added _envs to API Keys.
    • Added separate body for Organization and ManagedOrganization (this affects Create Organization, Retrieve Organization, and Update Organization).
    • Added type MANAGED_ORGANIZATION to Organization.
    • Added _envs to Organizations.
    • Added Enable Environment for Organization to actively enable a certain environment.
    • Created new StatusResponse type.
    • Changed all DELETE requests to return a StatusResponse.
    • Removed kind field for API Key requests (replaced with _envs).
  • 0.1.0-draft:
    • Initial API draft.

Errors and Status Codes

Our API uses standard HTTP status codes to indicate the success or failure of requests:

Status 2xx

Status codes in the 200-299 range indicate success.

Status 4xx

Status codes in the 400-499 range indicate errors that have been caused by the client (e.g., a malformed request body has been sent).
Retrying such requests with the same request body is pointless and will result in the same status code again. Some 4xx errors can be handled programmatically may therefore include an additional error code like the following example:

{
  "status_code": 400,
  "error": "Bad Request",
  "code": "E_SOME_ERROR",
  "message": "Something bad happened"
}

Status 5xx

Status codes in the 500-599 range indicate errors on our side. Errors on our side can be considered temporary. This means that you may safely retry (see Idempotent Requests) the same request after a certain delay. We recommend an exponential backoff in your retry logic. Otherwise you might risk running into a 429 (Too Many Requests) error.

Request IDs

For each request, our API associates a unique request identifier to it. You will find this request identifier in the response headers, under X-Request-ID. If you need to contact us about a specific request (e.g. for debugging porposes) you have issued, please be sure to include the request identifier as this will greatly facilitate resolution on both sides.

Metadata

Another concept of our API is custom, user-defined metadata. Most resources in our API (e.g. Organizations) include a metadata property, that can be used to attach and store additional, structured information suchs resources.

For example, you could store a unique identifier for a particular receipt or invoice from your system on Transaction object. That way, you can effectively link a Transaction in our API to thr corresponding receipt / invoice in your system.

Note: You can specify up to 20 keys, with key names up to 40 characters long and values up to 500 characters long.

Authentication

Our API uses JWT tokens to authenticate requests. API requests without authentication will fail. All API requests have to be made over HTTPS, while requests made over plain HTTP will fail.

JWT

A JSON Web Token (JWT) used for access control and authorization.

API keys have to be obtained via the fiskaly dashboard.

  • Usage format: Bearer <JWT>
  • Example HTTP header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Security Scheme Type: HTTP
HTTP Authorization Scheme: bearer
Bearer format: JWT

Retrieve token

Access to our API is only granted with a valid JWT / authorization token that must be obtained using this endpoint.

Note: If you don't have an api_key yet, you have to create one yourself.

Request Body schema: application/json
One of
api_key
required
string (ApiKeyKey)

Key of an API Key

api_secret
required
string (ApiKeySecret)

Secret of an API Key (only given, when POST request)

Responses

Request samples

Content type
application/json
Example
{
  • "api_key": "string",
  • "api_secret": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "access_token_claims": {
    },
  • "access_token_expires_in": 300,
  • "access_token_expires_at": 1577833200,
  • "refresh_token": "string",
  • "refresh_token_expires_in": 300,
  • "refresh_token_expires_at": 1577833200
}

Organizations

List Organizations

List all Organizations

query Parameters
order_by
string
Default: "name"
Enum: "name" "id" "address_line1" "zip" "town" "display_name" "vat_id" "address_line2" "state" "tax_number" "economy_id"
order
string
Default: "asc"
Enum: "asc" "desc"
limit
integer <= 5000
Default: 100
offset
integer
Default: 0
env
string
Enum: "TEST" "LIVE"
type
string
Enum: "MANAGED_ORGANIZATION" "ORGANIZATION"
managed_by_organization_id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "count": 9007199254740991,
  • "_type": "ORGANIZATION_LIST"
}

Create Organization

Create a new Organization

Request Body schema: application/json
One of
name
required
string >= 3 characters
display_name
string
vat_id
string
contact_person_id
string <uuid>

Contact person for policy

address_line1
required
string non-empty
address_line2
string
zip
required
string non-empty
town
required
string non-empty
state
string (State)

Federate state

country_code
required
string (CountryCode) = 3 characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATF" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BVT" "BWA" "CAF" "CAN" "CCK" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESH" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HKG" "HMD" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IOT" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JEY" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAF" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NFK" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRI" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SGS" "SHN" "SJM" "SLB" "SLE" "SLV" "SMR" "SOM" "SPM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SXM" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "UMI" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"
tax_number
string
economy_id
string

"Wirtschafts-Identifikationsnummer" for Germany

object (BillingOptions)

Allows an organization to be billed to another organization

billing_address_id
string <uuid> (BillingAddressId)

ID of the Billing Address

object (Metadata) <= 20 properties

You can use this parameter to attach custom key-value data to an object. Metadata is useful for storing additional, structured information on an object. Note: You can specify up to 20 keys, with key names up to 40 characters long and values up to 500 characters long.

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "display_name": "string",
  • "vat_id": "string",
  • "contact_person_id": "00000000-0000-0000-0000-000000000000",
  • "address_line1": "string",
  • "address_line2": "string",
  • "zip": "string",
  • "town": "string",
  • "state": "string",
  • "country_code": "DEU",
  • "tax_number": "string",
  • "economy_id": "string",
  • "billing_options": {
    },
  • "billing_address_id": "00000000-0000-0000-0000-000000000000",
  • "metadata": {}
}

Response samples

Content type
application/json
{
  • "_id": "00000000-0000-0000-0000-000000000000",
  • "_type": "ORGANIZATION",
  • "_envs": [
    ],
  • "name": "string",
  • "display_name": "string",
  • "vat_id": "string",
  • "contact_person_id": "00000000-0000-0000-0000-000000000000",
  • "address_line1": "string",
  • "address_line2": "string",
  • "zip": "string",
  • "town": "string",
  • "state": "string",
  • "country_code": "DEU",
  • "tax_number": "string",
  • "economy_id": "string",
  • "billing_options": {
    },
  • "billing_address_id": "00000000-0000-0000-0000-000000000000",
  • "metadata": {},
  • "managed_by_organization_id": "00000000-0000-0000-0000-000000000000",
  • "managed_configuration": {
    },
  • "created_by_user": "27517bc4-bc7e-445c-b9ea-ea9612f4fa59"
}

Retrieve Organization

Retrieve an Organization

path Parameters
organization_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

Responses

Response samples

Content type
application/json
{
  • "_id": "00000000-0000-0000-0000-000000000000",
  • "_type": "ORGANIZATION",
  • "_envs": [
    ],
  • "name": "string",
  • "display_name": "string",
  • "vat_id": "string",
  • "contact_person_id": "00000000-0000-0000-0000-000000000000",
  • "address_line1": "string",
  • "address_line2": "string",
  • "zip": "string",
  • "town": "string",
  • "state": "string",
  • "country_code": "DEU",
  • "tax_number": "string",
  • "economy_id": "string",
  • "billing_options": {
    },
  • "billing_address_id": "00000000-0000-0000-0000-000000000000",
  • "metadata": {},
  • "managed_by_organization_id": "00000000-0000-0000-0000-000000000000",
  • "managed_configuration": {
    },
  • "created_by_user": "27517bc4-bc7e-445c-b9ea-ea9612f4fa59"
}

Update Organization

Update an Organization

path Parameters
organization_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000
Request Body schema: application/json
name
string >= 3 characters
display_name
string
vat_id
string
contact_person_id
string <uuid>

Contact person for policy

address_line1
string non-empty
address_line2
string
zip
string non-empty
town
string non-empty
state
string (State)

Federate state

country_code
string (CountryCode) = 3 characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATF" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BVT" "BWA" "CAF" "CAN" "CCK" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESH" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HKG" "HMD" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IOT" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JEY" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAF" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NFK" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRI" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SGS" "SHN" "SJM" "SLB" "SLE" "SLV" "SMR" "SOM" "SPM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SXM" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "UMI" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"
tax_number
string
economy_id
string

"Wirtschafts-Identifikationsnummer" for Germany

object (BillingOptions)

Allows an organization to be billed to another organization

billing_address_id
string <uuid> (BillingAddressId)

ID of the Billing Address

object (Metadata) <= 20 properties

You can use this parameter to attach custom key-value data to an object. Metadata is useful for storing additional, structured information on an object. Note: You can specify up to 20 keys, with key names up to 40 characters long and values up to 500 characters long.

managed_by_organization_id
string <uuid> (OrganizationId)

ID of the Organization

object (ManagedOrganizationConfiguration)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "display_name": "string",
  • "vat_id": "string",
  • "contact_person_id": "00000000-0000-0000-0000-000000000000",
  • "address_line1": "string",
  • "address_line2": "string",
  • "zip": "string",
  • "town": "string",
  • "state": "string",
  • "country_code": "DEU",
  • "tax_number": "string",
  • "economy_id": "string",
  • "billing_options": {
    },
  • "billing_address_id": "00000000-0000-0000-0000-000000000000",
  • "metadata": {},
  • "managed_by_organization_id": "00000000-0000-0000-0000-000000000000",
  • "managed_configuration": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "00000000-0000-0000-0000-000000000000",
  • "_type": "ORGANIZATION",
  • "_envs": [
    ],
  • "name": "string",
  • "display_name": "string",
  • "vat_id": "string",
  • "contact_person_id": "00000000-0000-0000-0000-000000000000",
  • "address_line1": "string",
  • "address_line2": "string",
  • "zip": "string",
  • "town": "string",
  • "state": "string",
  • "country_code": "DEU",
  • "tax_number": "string",
  • "economy_id": "string",
  • "billing_options": {
    },
  • "billing_address_id": "00000000-0000-0000-0000-000000000000",
  • "metadata": {},
  • "managed_by_organization_id": "00000000-0000-0000-0000-000000000000",
  • "managed_configuration": {
    },
  • "created_by_user": "27517bc4-bc7e-445c-b9ea-ea9612f4fa59"
}

Delete Organization

Delete an Organization.
Note: This endpoint is not yet implemented entirely. Please contact dev-support@fiskaly.com to have organizations deleted as described in the article How to delete an organization?.

path Parameters
organization_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

Responses

Response samples

Content type
application/json
{
  • "_success": true
}

Enable Environment for Organization

Warning! Cannot be undone!

path Parameters
organization_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000
Request Body schema: application/json
env
string (Env)
Enum: "TEST" "LIVE"

Responses

Request samples

Content type
application/json
{
  • "env": "TEST"
}

Response samples

Content type
application/json
{
  • "_success": true
}

API Keys

List API Keys

List API Keys

path Parameters
organization_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000
query Parameters
order_by
string
Default: "created_at"
Enum: "name" "status" "created_at"
order
string
Default: "asc"
Enum: "asc" "desc"
limit
integer <= 100
Default: 100
offset
integer
Default: 0
status
string
Enum: "enabled" "disabled"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "count": 9007199254740991,
  • "_type": "API_KEY_LIST"
}

Create API Key

Create an API Key

path Parameters
organization_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000
Request Body schema: application/json
One of
name
required
string (ApiKeyName) [ 3 .. 30 ] characters ^[a-z0-9\-]{3,30}$

Name of the API Key

status
required
string (ApiKeyStatus)
Default: "enabled"
Enum: "enabled" "disabled"
object (Metadata) <= 20 properties

You can use this parameter to attach custom key-value data to an object. Metadata is useful for storing additional, structured information on an object. Note: You can specify up to 20 keys, with key names up to 40 characters long and values up to 500 characters long.

Responses

Request samples

Content type
application/json
Example
{}

Response samples

Content type
application/json
{
  • "_id": "00000000-0000-0000-0000-000000000000",
  • "_type": "API_KEY",
  • "_envs": [
    ],
  • "key": "string",
  • "secret": "string",
  • "created_at": 1577833200,
  • "created_by_user": "27517bc4-bc7e-445c-b9ea-ea9612f4fa59",
  • "name": "string",
  • "status": "enabled",
  • "metadata": {},
  • "managed_by_organization_id": "00000000-0000-0000-0000-000000000000"
}

Retrieve API Key

Retrieve an existing API Key

path Parameters
organization_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000
key_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

Responses

Response samples

Content type
application/json
{
  • "_id": "00000000-0000-0000-0000-000000000000",
  • "_type": "API_KEY",
  • "_envs": [
    ],
  • "key": "string",
  • "secret": "string",
  • "created_at": 1577833200,
  • "created_by_user": "27517bc4-bc7e-445c-b9ea-ea9612f4fa59",
  • "name": "string",
  • "status": "enabled",
  • "metadata": {},
  • "managed_by_organization_id": "00000000-0000-0000-0000-000000000000"
}

Update API Key

Update an API Key

path Parameters
organization_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000
key_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000
Request Body schema: application/json
status
string (ApiKeyStatus)
Default: "enabled"
Enum: "enabled" "disabled"
object (Metadata) <= 20 properties

You can use this parameter to attach custom key-value data to an object. Metadata is useful for storing additional, structured information on an object. Note: You can specify up to 20 keys, with key names up to 40 characters long and values up to 500 characters long.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "_id": "00000000-0000-0000-0000-000000000000",
  • "_type": "API_KEY",
  • "_envs": [
    ],
  • "key": "string",
  • "secret": "string",
  • "created_at": 1577833200,
  • "created_by_user": "27517bc4-bc7e-445c-b9ea-ea9612f4fa59",
  • "name": "string",
  • "status": "enabled",
  • "metadata": {},
  • "managed_by_organization_id": "00000000-0000-0000-0000-000000000000"
}

Delete API Key

Delete an existing API Key

path Parameters
organization_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000
key_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

Responses

Response samples

Content type
application/json
{
  • "_success": true
}

Users

List Users

List existing Users

path Parameters
organization_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000
query Parameters
order_by
string
Default: "email"
Enum: "id" "email" "first_name" "last_name"
order
string
Default: "asc"
Enum: "asc" "desc"
limit
integer <= 5000
Default: 100
offset
integer
Default: 0
email
string
first_name
string
last_name
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "count": 9007199254740991,
  • "_type": "USER_LIST"
}

Invite User

Invite a User

path Parameters
organization_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000
Request Body schema: application/json
email
required
string <email>
first_name
string
last_name
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string"
}

Response samples

Content type
application/json
{
  • "_id": "00000000-0000-0000-0000-000000000000",
  • "_type": "USER",
  • "_envs": [
    ],
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string"
}

Delete User

Delete user from organization.

This will not delete the user from our system.

path Parameters
organization_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000
user_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

Responses

Response samples

Content type
application/json
{
  • "_success": true
}

Billing Addresses

List Billing Addresses

List all billing addresses of all organizations that the user has access to.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "count": 9007199254740991,
  • "_type": "BILLING_ADDRESS_LIST"
}

Create Billing Address

Create new Billing Address

Request Body schema: application/json
vat_id
string
recipient
required
string non-empty

e.g. company name

recipient_additions
string

e.g. receiving branch/contact person

billing_contact_id
string <uuid>

User who is responsible to handle billing

address_line1
required
string non-empty
address_line2
string
zip
required
string non-empty
town
required
string non-empty
state
string (State)

Federate state

country_code
required
string (CountryCode) = 3 characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATF" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BVT" "BWA" "CAF" "CAN" "CCK" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESH" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HKG" "HMD" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IOT" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JEY" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAF" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NFK" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRI" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SGS" "SHN" "SJM" "SLB" "SLE" "SLV" "SMR" "SOM" "SPM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SXM" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "UMI" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"
organization_id
string <uuid> (OrganizationId)

ID of the Organization

object (Metadata) <= 20 properties

You can use this parameter to attach custom key-value data to an object. Metadata is useful for storing additional, structured information on an object. Note: You can specify up to 20 keys, with key names up to 40 characters long and values up to 500 characters long.

Responses

Request samples

Content type
application/json
{
  • "vat_id": "string",
  • "recipient": "string",
  • "recipient_additions": "string",
  • "billing_contact_id": "00000000-0000-0000-0000-000000000000",
  • "address_line1": "string",
  • "address_line2": "string",
  • "zip": "string",
  • "town": "string",
  • "state": "string",
  • "country_code": "DEU",
  • "organization_id": "00000000-0000-0000-0000-000000000000",
  • "metadata": {}
}

Response samples

Content type
application/json
{
  • "vat_id_valid": true,
  • "vat_id": "string",
  • "recipient": "string",
  • "recipient_additions": "string",
  • "billing_contact_id": "00000000-0000-0000-0000-000000000000",
  • "address_line1": "string",
  • "address_line2": "string",
  • "zip": "string",
  • "town": "string",
  • "state": "string",
  • "country_code": "DEU",
  • "organization_id": "00000000-0000-0000-0000-000000000000",
  • "metadata": {},
  • "_id": "00000000-0000-0000-0000-000000000000",
  • "_type": "BILLING_ADDRESS",
  • "_envs": [
    ]
}

Retrieve Billing Address

Retrieve Billing Address

path Parameters
address_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

Responses

Response samples

Content type
application/json
{
  • "vat_id_valid": true,
  • "vat_id": "string",
  • "recipient": "string",
  • "recipient_additions": "string",
  • "billing_contact_id": "00000000-0000-0000-0000-000000000000",
  • "address_line1": "string",
  • "address_line2": "string",
  • "zip": "string",
  • "town": "string",
  • "state": "string",
  • "country_code": "DEU",
  • "organization_id": "00000000-0000-0000-0000-000000000000",
  • "metadata": {},
  • "_id": "00000000-0000-0000-0000-000000000000",
  • "_type": "BILLING_ADDRESS",
  • "_envs": [
    ]
}

Update Billing Address

Update a Billing Address

path Parameters
address_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000
Request Body schema: application/json
vat_id
string
recipient
string non-empty

e.g. company name

recipient_additions
string

e.g. receiving branch/contact person

billing_contact_id
string <uuid>

User who is responsible to handle billing

address_line1
string non-empty
address_line2
string
zip
string non-empty
town
string non-empty
state
string (State)

Federate state

country_code
string (CountryCode) = 3 characters
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATF" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BVT" "BWA" "CAF" "CAN" "CCK" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESH" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HKG" "HMD" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IOT" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JEY" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAF" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NFK" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRI" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SGS" "SHN" "SJM" "SLB" "SLE" "SLV" "SMR" "SOM" "SPM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SXM" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "UMI" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"
organization_id
string <uuid> (OrganizationId)

ID of the Organization

object (Metadata) <= 20 properties

You can use this parameter to attach custom key-value data to an object. Metadata is useful for storing additional, structured information on an object. Note: You can specify up to 20 keys, with key names up to 40 characters long and values up to 500 characters long.

Responses

Request samples

Content type
application/json
{
  • "vat_id": "string",
  • "recipient": "string",
  • "recipient_additions": "string",
  • "billing_contact_id": "00000000-0000-0000-0000-000000000000",
  • "address_line1": "string",
  • "address_line2": "string",
  • "zip": "string",
  • "town": "string",
  • "state": "string",
  • "country_code": "DEU",
  • "organization_id": "00000000-0000-0000-0000-000000000000",
  • "metadata": {}
}

Response samples

Content type
application/json
{
  • "vat_id_valid": true,
  • "vat_id": "string",
  • "recipient": "string",
  • "recipient_additions": "string",
  • "billing_contact_id": "00000000-0000-0000-0000-000000000000",
  • "address_line1": "string",
  • "address_line2": "string",
  • "zip": "string",
  • "town": "string",
  • "state": "string",
  • "country_code": "DEU",
  • "organization_id": "00000000-0000-0000-0000-000000000000",
  • "metadata": {},
  • "_id": "00000000-0000-0000-0000-000000000000",
  • "_type": "BILLING_ADDRESS",
  • "_envs": [
    ]
}

Delete Billing Address

Delete a Billing Address

path Parameters
address_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

Responses

Response samples

Content type
application/json
{
  • "_success": true
}

Was this page helpful?