Partner API

Operations related to Qvalia Partners

Get Accounts

get

/partner/{partnerRegNo}/account

An API to fetch (GET) Qvalia accounts under your Partner account.

With JSON, use the limit parameter to change the number of returned messages and combine it with offset to traverse through your available records.

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

Query parameters

limitnumberOptional

How many records to return in Array (default is 25)

Default: 25Example: 5

offsetnumberOptional

Where to start index for using limit/offset listing

Default: 0Example: 0

Responses

200

application/json

statusstringOptionalExample: success

204

No Content

text/plain

401

Unauthorized

text/plain

500

Internal Server Error

application/json

get/partner/{partnerRegNo}/account

GET /partner/{partnerRegNo}/account HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": "success",
  "data": {
    "accounts": [
      {
        "accountRegNo": "SE1234567890",
        "vatNumber": "SE123456789001",
        "name": "A company AB",
        "email": "john.doe@acompany.com",
        "address": "A street name 123",
        "additionalAddress": "c/o My mailbox",
        "boxAddress": "Box 123",
        "postalCode": "123 45",
        "country": "SE",
        "city": "Stockholm",
        "currency": "SEK",
        "vat": 25,
        "website": "https://www.myweb.com",
        "invoiceEmail": "invoices@myweb.com",
        "invoicePhone": "+468123456",
        "OurReference": "Finance Person",
        "appFeatures": {
          "whiteLabel": {
            "active": true,
            "wl_partners": [
              "wl_acme_partner"
            ]
          },
          "invoiceManagement": {
            "active": true
          },
          "orderManagement": {
            "active": true
          },
          "catalogueManagement": {
            "active": true
          },
          "analytics": {
            "active": true
          },
          "prePosting": {
            "active": true
          },
          "capture": {
            "active": true
          },
          "unspscClassification": {
            "active": true
          },
          "clarityAI": {
            "active": true
          },
          "co2Emission": {
            "active": true
          },
          "workflow": {
            "active": true
          },
          "apiIntegration": {
            "active": true
          },
          "sftpIntegration": {
            "active": true
          },
          "reconciliation": {
            "active": true
          }
        }
      }
    ],
    "total": 1
  }
}

Post Account

post

/partner/{partnerRegNo}/account

An API to add (POST) a Qvalia account under your Partner account.

Important! You must add `appFeatures` and `apiIntegration` for the child account to be able to use the API for the child account!

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

Body

accountRegNostringRequiredExample: SE1234567890

vatNumberstringOptional

This is normally EU VAT number used for creating supplier invoices

Example: SE123456789001

namestringRequiredExample: A company AB

emailstringOptionalExample: john.doe@acompany.com

addressstringRequiredExample: A street name 123

additionalAddressstringOptionalExample: c/o My mailbox

boxAddressstringOptionalExample: Box 123

postalCodestringRequiredExample: 123 45

countrystringRequiredExample: SEPattern: ^[A-Z]{2}$

citystringOptionalExample: Stockholm

currencystringOptionalExample: SEK

vatnumberOptional

This is the default VAT rate used for creating supplier invoices

Example: 25

websitestringOptional

This is used in page footer of PDF supplier invoices

Example: https://www.myweb.com

invoiceEmailstringOptional

This is used in page footer of PDF supplier invoices

Example: invoices@myweb.com

invoicePhonestringOptional

This is used in page footer of PDF supplier invoices

Example: +468123456

OurReferencestringOptional

This is used in page footer of PDF supplier invoices

Example: Finance Person

Responses

200

application/json

successstringOptionalExample: account SE1234567890 created for partner SE9876543210

401

Unauthorized

text/plain

409

Conflict

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post/partner/{partnerRegNo}/account

POST /partner/{partnerRegNo}/account HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 910

{
  "accountRegNo": "SE1234567890",
  "vatNumber": "SE123456789001",
  "name": "A company AB",
  "email": "john.doe@acompany.com",
  "address": "A street name 123",
  "additionalAddress": "c/o My mailbox",
  "boxAddress": "Box 123",
  "postalCode": "123 45",
  "country": "SE",
  "city": "Stockholm",
  "currency": "SEK",
  "vat": 25,
  "website": "https://www.myweb.com",
  "invoiceEmail": "invoices@myweb.com",
  "invoicePhone": "+468123456",
  "OurReference": "Finance Person",
  "appFeatures": {
    "whiteLabel": {
      "active": true,
      "wl_partners": [
        "wl_acme_partner"
      ]
    },
    "invoiceManagement": {
      "active": true
    },
    "orderManagement": {
      "active": true
    },
    "catalogueManagement": {
      "active": true
    },
    "analytics": {
      "active": true
    },
    "prePosting": {
      "active": true
    },
    "capture": {
      "active": true
    },
    "unspscClassification": {
      "active": true
    },
    "clarityAI": {
      "active": true
    },
    "co2Emission": {
      "active": true
    },
    "workflow": {
      "active": true
    },
    "apiIntegration": {
      "active": true
    },
    "sftpIntegration": {
      "active": true
    },
    "reconciliation": {
      "active": true
    }
  }
}

{
  "success": "account SE1234567890 created for partner SE9876543210"
}

Get Account

get

/partner/{partnerRegNo}/account/{accountRegNo}

An API to fetch (GET) a Qvalia account under your Partner account.

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

Responses

200

application/json

statusstringOptionalExample: success

204

No Content

text/plain

401

Unauthorized

text/plain

500

Internal Server Error

application/json

get/partner/{partnerRegNo}/account/{accountRegNo}

GET /partner/{partnerRegNo}/account/{accountRegNo} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": "success",
  "data": {
    "accountRegNo": "SE1234567890",
    "vatNumber": "SE123456789001",
    "name": "A company AB",
    "email": "john.doe@acompany.com",
    "address": "A street name 123",
    "additionalAddress": "c/o My mailbox",
    "boxAddress": "Box 123",
    "postalCode": "123 45",
    "country": "SE",
    "city": "Stockholm",
    "currency": "SEK",
    "vat": 25,
    "website": "https://www.myweb.com",
    "invoiceEmail": "invoices@myweb.com",
    "invoicePhone": "+468123456",
    "OurReference": "Finance Person",
    "appFeatures": {
      "whiteLabel": {
        "active": true,
        "wl_partners": [
          "wl_acme_partner"
        ]
      },
      "invoiceManagement": {
        "active": true
      },
      "orderManagement": {
        "active": true
      },
      "catalogueManagement": {
        "active": true
      },
      "analytics": {
        "active": true
      },
      "prePosting": {
        "active": true
      },
      "capture": {
        "active": true
      },
      "unspscClassification": {
        "active": true
      },
      "clarityAI": {
        "active": true
      },
      "co2Emission": {
        "active": true
      },
      "workflow": {
        "active": true
      },
      "apiIntegration": {
        "active": true
      },
      "sftpIntegration": {
        "active": true
      },
      "reconciliation": {
        "active": true
      }
    }
  }
}

Put Account

put

/partner/{partnerRegNo}/account/{accountRegNo}

An API to change (PUT) a Qvalia account under your Partner account.

Important! You must add `appFeatures` and `apiIntegration` for the child account to be able to use the API for the child account!

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

Body

vatNumberstringOptional

This is normally EU VAT number used for creating supplier invoices

Example: SE123456789001

namestringOptionalExample: A company AB

emailstringOptionalExample: john.doe@acompany.com

addressstringOptionalExample: A street name 123

additionalAddressstringOptionalExample: c/o My mailbox

boxAddressstringOptionalExample: Box 123

postalCodestringOptionalExample: 123 45

countrystringOptionalExample: SEPattern: ^[A-Z]{2}$

citystringOptionalExample: Stockholm

currencystringOptionalExample: SEK

vatnumberOptional

This is the default VAT rate used for creating supplier invoices

Example: 25

websitestringOptional

This is used in page footer of PDF supplier invoices

Example: https://www.myweb.com

invoiceEmailstringOptional

This is used in page footer of PDF supplier invoices

Example: invoices@myweb.com

invoicePhonestringOptional

This is used in page footer of PDF supplier invoices

Example: +468123456

OurReferencestringOptional

This is used in page footer of PDF supplier invoices

Example: Finance Person

Responses

200

application/json

successstringOptionalExample: account SE1234567890 updated for partner SE9876543210

401

Unauthorized

text/plain

404

Not Found

text/plain

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

put/partner/{partnerRegNo}/account/{accountRegNo}

PUT /partner/{partnerRegNo}/account/{accountRegNo} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 880

{
  "vatNumber": "SE123456789001",
  "name": "A company AB",
  "email": "john.doe@acompany.com",
  "address": "A street name 123",
  "additionalAddress": "c/o My mailbox",
  "boxAddress": "Box 123",
  "postalCode": "123 45",
  "country": "SE",
  "city": "Stockholm",
  "currency": "SEK",
  "vat": 25,
  "website": "https://www.myweb.com",
  "invoiceEmail": "invoices@myweb.com",
  "invoicePhone": "+468123456",
  "OurReference": "Finance Person",
  "appFeatures": {
    "whiteLabel": {
      "active": true,
      "wl_partners": [
        "wl_acme_partner"
      ]
    },
    "invoiceManagement": {
      "active": true
    },
    "orderManagement": {
      "active": true
    },
    "catalogueManagement": {
      "active": true
    },
    "analytics": {
      "active": true
    },
    "prePosting": {
      "active": true
    },
    "capture": {
      "active": true
    },
    "unspscClassification": {
      "active": true
    },
    "clarityAI": {
      "active": true
    },
    "co2Emission": {
      "active": true
    },
    "workflow": {
      "active": true
    },
    "apiIntegration": {
      "active": true
    },
    "sftpIntegration": {
      "active": true
    },
    "reconciliation": {
      "active": true
    }
  }
}

{
  "success": "account SE1234567890 updated for partner SE9876543210"
}

Get Users in Account

get

/partner/{partnerRegNo}/account/{accountRegNo}/user

An API to fetch (GET) Qvalia users in an account, under your Partner account.

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

Responses

200

application/json

statusstringOptionalExample: success

204

No Content

text/plain

401

Unauthorized

text/plain

500

Internal Server Error

application/json

get/partner/{partnerRegNo}/account/{accountRegNo}/user

GET /partner/{partnerRegNo}/account/{accountRegNo}/user HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": "success",
  "data": {
    "accountRegNo": "SE1234567890",
    "users": [
      {
        "email": "user@qvalia.com",
        "name": "text",
        "privilege": "viewer",
        "phone": "text",
        "language": "text",
        "title": "text",
        "countryCode": "SE"
      }
    ]
  }
}

Post Account

post

/partner/{partnerRegNo}/account/{accountRegNo}/user

An API to add (POST) a User to a Qvalia account under your Partner account.

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

Body

emailstringRequiredExample: user@qvalia.com

namestringRequired

privilegestring · enumOptionalPattern: ^(viewer|user|admin)$Possible values:

phonestring · nullableOptional

languagestring · enumRequiredPattern: ^[en|sv|fi]$Possible values:

titlestring · nullableOptional

Responses

200

application/json

statusstringOptionalExample: success

401

Unauthorized

text/plain

409

Conflict

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post/partner/{partnerRegNo}/account/{accountRegNo}/user

POST /partner/{partnerRegNo}/account/{accountRegNo}/user HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "email": "user@qvalia.com",
  "name": "text",
  "privilege": "viewer",
  "phone": "text",
  "language": "en",
  "title": "text"
}

{
  "status": "success",
  "data": {
    "success": "User users@qvalia.com added to account SE1234567890 for partner SE9876543210"
  }
}

Get Users in Account

get

/partner/{partnerRegNo}/account/{accountRegNo}/user/{userEmail}

An API to fetch (GET) a Qvalia user in an account, under your Partner account.

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

userEmailstringRequired

User email for the account, e.g. "user@qvalia.com"

Responses

200

application/json

statusstringOptionalExample: success

204

No Content

text/plain

401

Unauthorized

text/plain

500

Internal Server Error

application/json

get/partner/{partnerRegNo}/account/{accountRegNo}/user/{userEmail}

GET /partner/{partnerRegNo}/account/{accountRegNo}/user/{userEmail} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": "success",
  "data": {
    "accountRegNo": "SE1234567890",
    "user": {
      "email": "user@qvalia.com",
      "name": "text",
      "privilege": "viewer",
      "phone": "text",
      "language": "text",
      "title": "text",
      "countryCode": "SE"
    }
  }
}

Put Account

put

/partner/{partnerRegNo}/account/{accountRegNo}/user/{userEmail}

An API to update (PUT) a User to a Qvalia account under your Partner account.

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

userEmailstringRequired

User email for the account, e.g. "user@qvalia.com"

Body

namestringOptional

privilegestring · enumOptionalPattern: ^(viewer|user|admin)$Possible values:

phonestring · nullableOptional

languagestringOptional

titlestring · nullableOptional

countryCodestring · nullableOptionalExample: SEPattern: ^[A-Z]{2}$

Responses

200

application/json

statusstringOptionalExample: success

401

Unauthorized

text/plain

404

Not Found

text/plain

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

put/partner/{partnerRegNo}/account/{accountRegNo}/user/{userEmail}

PUT /partner/{partnerRegNo}/account/{accountRegNo}/user/{userEmail} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "name": "text",
  "privilege": "viewer",
  "phone": "text",
  "language": "text",
  "title": "text",
  "countryCode": "SE"
}

{
  "status": "success",
  "data": {
    "success": "User users@qvalia.com updated for account SE1234567890 for partner SE9876543210"
  }
}

Delete User

delete

/partner/{partnerRegNo}/account/{accountRegNo}/user/{userEmail}

An API to DELETE a User from a Qvalia account under your Partner account.

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

userEmailstringRequired

User email for the account, e.g. "user@qvalia.com"

Responses

200

application/json

statusstringOptionalExample: success

401

Unauthorized

text/plain

404

Not Found

text/plain

500

Internal Server Error

application/json

delete/partner/{partnerRegNo}/account/{accountRegNo}/user/{userEmail}

DELETE /partner/{partnerRegNo}/account/{accountRegNo}/user/{userEmail} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": "success",
  "data": {
    "success": "User deleted from account SE1234567890 for partner SE9876543210"
  }
}

Get Bankaccounts in Account

get

/partner/{partnerRegNo}/account/{accountRegNo}/bankaccount

An API to fetch (GET) bankaccounts in an account, under your Partner account.

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

Responses

200

application/json

statusstringOptionalExample: success

204

No Content

text/plain

401

Unauthorized

text/plain

500

Internal Server Error

application/json

get/partner/{partnerRegNo}/account/{accountRegNo}/bankaccount

GET /partner/{partnerRegNo}/account/{accountRegNo}/bankaccount HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": "success",
  "data": {
    "accountRegNo": "SE1234567890",
    "bankAccounts": [
      {
        "account_name": "text",
        "type": "text",
        "account_number": "text",
        "is_default": true,
        "description": "text",
        "bic": "text",
        "bank_name": "text",
        "bank_address": "text",
        "bank_postal_code": "text",
        "bank_city": "text",
        "bank_country": "text"
      }
    ]
  }
}

Post Bankaccount

post

/partner/{partnerRegNo}/account/{accountRegNo}/bankaccount

An API to add (POST) a Bankaccount to a Qvalia account under your Partner account.

The bank account for the partner account is used when/if a partner account generates/creates an invoice in Qvalia Apps. If your customer don't have access to Qvalia standard App, e.g. you are using a White Label solution, the bank account marked as is_default will be used (and only one default account may exist!).

For Swedish companies (country: SE) Plusgiro and Bankgiro are allowed as type, for any other country either IBAN or AccountNumber should be used!

The type AccountNumber shall be used for any unspecified, and local, bank accounts (i.e. that's not IBAN, Bankgiro or Plusgiro)

The account_number attribute is used for all account types, and for IBAN it must start with the country code, e.g. SE4550000000058398257466.

bic (or S.W.I.F.T. code) is optional if IBAN is given.

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

Body

account_namestringRequired

typestring · enumRequiredPattern: [IBAN|Bankgiro|Plusgiro|AccountNumber]Possible values:

account_numberstringRequired

is_defaultbooleanOptional

descriptionstringOptional

bicstringOptionalPattern: ^[A-Z]{6}[0-9A-Z]{2}([0-9A-Z]{3})?$

bank_namestringOptional

bank_addressstringOptional

bank_postal_codestringOptional

bank_citystringOptional

bank_countrystringOptional

Responses

200

application/json

statusstringOptionalExample: success

401

Unauthorized

text/plain

409

Conflict

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post/partner/{partnerRegNo}/account/{accountRegNo}/bankaccount

POST /partner/{partnerRegNo}/account/{accountRegNo}/bankaccount HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 221

{
  "account_name": "text",
  "type": "IBAN",
  "account_number": "text",
  "is_default": true,
  "description": "text",
  "bic": "text",
  "bank_name": "text",
  "bank_address": "text",
  "bank_postal_code": "text",
  "bank_city": "text",
  "bank_country": "text"
}

{
  "status": "success",
  "data": {
    "success": "Bankaccount added to account SE1234567890 for partner SE9876543210"
  }
}

Get Bankaccounts in Account

get

/partner/{partnerRegNo}/account/{accountRegNo}/bankaccount/{bankAccount}

An API to fetch (GET) a Bankaccount in an account, under your Partner account.

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

bankAccountstringRequired

A bank account as created, e.g. "SE4550000000058398257466" or "1234-567"

Responses

200

application/json

statusstringOptionalExample: success

204

No Content

text/plain

401

Unauthorized

text/plain

500

Internal Server Error

application/json

get/partner/{partnerRegNo}/account/{accountRegNo}/bankaccount/{bankAccount}

GET /partner/{partnerRegNo}/account/{accountRegNo}/bankaccount/{bankAccount} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": "success",
  "data": {
    "accountRegNo": "SE12345567890",
    "bankAccount": {
      "account_name": "text",
      "type": "text",
      "account_number": "text",
      "is_default": true,
      "description": "text",
      "bic": "text",
      "bank_name": "text",
      "bank_address": "text",
      "bank_postal_code": "text",
      "bank_city": "text",
      "bank_country": "text"
    }
  }
}

Put Bankaccount

put

/partner/{partnerRegNo}/account/{accountRegNo}/bankaccount/{bankAccount}

An API to update (PUT) a Bankaccount to a Qvalia account under your Partner account.

For Swedish companies (country: SE) Plusgiro and Bankgiro are allowed as type, for any other country either IBAN or AccountNumber should be used!

The type AccountNumber shall be used for any unspecified, and local, bank accounts (i.e. that's not IBAN, Bankgiro or Plusgiro)

The account_number attribute is used for all account types, and for IBAN it must start with the country code, e.g. SE4550000000058398257466.

bic (or S.W.I.F.T. code) is optional if IBAN is given.

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

bankAccountstringRequired

A bank account as created, e.g. "SE4550000000058398257466" or "1234-567"

Body

account_namestringRequired

typestring · enumRequiredPattern: [IBAN|Bankgiro|Plusgiro|AccountNumber]Possible values:

is_defaultbooleanOptional

descriptionstringOptional

bicstringOptionalPattern: ^[A-Z]{6}[0-9A-Z]{2}([0-9A-Z]{3})?$

bank_namestringOptional

bank_addressstringOptional

bank_postal_codestringOptional

bank_citystringOptional

bank_countrystringOptional

Responses

200

application/json

statusstringOptionalExample: success

401

Unauthorized

text/plain

404

Not Found

text/plain

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

put/partner/{partnerRegNo}/account/{accountRegNo}/bankaccount/{bankAccount}

PUT /partner/{partnerRegNo}/account/{accountRegNo}/bankaccount/{bankAccount} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "account_name": "text",
  "type": "IBAN",
  "is_default": true,
  "description": "text",
  "bic": "text",
  "bank_name": "text",
  "bank_address": "text",
  "bank_postal_code": "text",
  "bank_city": "text",
  "bank_country": "text"
}

{
  "status": "success",
  "data": {
    "success": "Bank account updated for account SE1234567890 for partner SE9876543210"
  }
}

Delete Bankaccount

delete

/partner/{partnerRegNo}/account/{accountRegNo}/bankaccount/{bankAccount}

An API to DELETE a Bankaccount from a Qvalia account under your Partner account.

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

bankAccountstringRequired

A bank account as created, e.g. "SE4550000000058398257466" or "1234-567"

Responses

200

application/json

statusstringOptionalExample: success

401

Unauthorized

text/plain

404

Not Found

text/plain

500

Internal Server Error

application/json

delete/partner/{partnerRegNo}/account/{accountRegNo}/bankaccount/{bankAccount}

DELETE /partner/{partnerRegNo}/account/{accountRegNo}/bankaccount/{bankAccount} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": "success",
  "data": {
    "success": "Bank account deleted from account SE1234567890 for partner SE9876543210"
  }
}

Get Peppol Identifier

get

/partner/{partnerRegNo}/peppol/lookup/{peppolId}

Find information about a Peppol identifier.

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

peppolIdstringRequired

PeppolId for the endpoint, e.g. "0007:9999999999"

Query parameters

docTypeRootstringOptional

Message Type, e.g. Invoice, OrderResponse, MLR

Responses

200

application/json

statusstringOptionalExample: success

401

Unauthorized

text/plain

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

get/partner/{partnerRegNo}/peppol/lookup/{peppolId}

GET /partner/{partnerRegNo}/peppol/lookup/{peppolId} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": "success",
  "data": {
    "matches": [
      {
        "participantID": {
          "scheme": "iso6523-actorid-upis",
          "value": "0007:5567321707"
        },
        "docTypes": [
          {
            "scheme": "busdox-docid-qns",
            "value": "urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:mlr:3::2.1"
          }
        ]
      }
    ],
    "exists": true,
    "rootDocTypeExists": false,
    "source": "SML"
  }
}

Get Account Peppol Identifiers

get

/partner/{partnerRegNo}/account/{accountRegNo}/peppol

An API to GET Peppol identifiers to a Qvalia account under your Partner account.

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

Responses

200

application/json

statusstringOptionalExample: success

401

Unauthorized

text/plain

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

get/partner/{partnerRegNo}/account/{accountRegNo}/peppol

GET /partner/{partnerRegNo}/account/{accountRegNo}/peppol HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": "success",
  "data": [
    {
      "peppolId": "0007:5567321707",
      "regNo": "SE5567321707",
      "description": "Some PeppolId",
      "businessCard": {
        "companyName": "Qvalia AB",
        "countryCode": "SE",
        "geographicalInformation": "Stockholm",
        "VAT": "SE556732170701",
        "orgNr": "SE5567321707",
        "suffix": "ABC"
      },
      "msgTypes": [
        "invoice-creditnote-2"
      ]
    }
  ]
}

Get Account Peppol Identifier

get

/partner/{partnerRegNo}/account/{accountRegNo}/peppol/{peppolId}

An API to GET a Peppol identifier to a Qvalia account under your Partner account.

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

peppolIdstringRequired

PeppolId for the endpoint, e.g. "0007:9999999999"

Responses

200

application/json

statusstringOptionalExample: success

401

Unauthorized

text/plain

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

get/partner/{partnerRegNo}/account/{accountRegNo}/peppol/{peppolId}

GET /partner/{partnerRegNo}/account/{accountRegNo}/peppol/{peppolId} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": "success",
  "data": {
    "peppolId": "0007:5567321707",
    "regNo": "SE5567321707",
    "description": "Some PeppolId",
    "businessCard": {
      "companyName": "Qvalia AB",
      "countryCode": "SE",
      "geographicalInformation": "Stockholm",
      "VAT": "SE556732170701",
      "orgNr": "SE5567321707",
      "suffix": "ABC"
    },
    "msgTypes": [
      "invoice-creditnote-2"
    ]
  }
}

Put Account Peppol Identifier

put

/partner/{partnerRegNo}/account/{accountRegNo}/peppol/{peppolId}

An API to add or update (PUT) a Peppol identifier to a Qvalia account under your Partner account.

If you utilize a Peppol group (receiving) for Peppol identifiers and not having separate Qvalia accounts for each of your customers then {accountRegNo} is your {partnerRegNo}

Peppol Document Types

You can find the list of allowed Peppol document types by navigating to https://docs.peppol.eu/edelivery/codelists/

They are updating the lists regularly but under that URL you'll always find the current active version. Under “Artifact” find the Document Types vX.X and click the “as HTML” to get a view of the list.

Under Associated Process/Profile Identifier(s) (on the far right in the table) you'll find the docTypes.profile value and under Peppol Document Type Identifier Value you'll get the value for docTypes.document.

If you register for Invoice, you should also register for CreditNote!

Add and update through a PUT

We've opted for a PUT operation for the creation (add) and update of Peppol identifiers as it is rather messy trying to update in a JSON structure. This means that you have to send the full object at any change (and obviously at create).

We'd recommend to write your code to first do a GET to find the current settings for the identifier, and then update the values you want to update and send the changed object in a PUT request.

The businessCard information is what is being added to the Peppol Directory and shown there, e.g.: https://directory.peppol.eu/public/locale-en US/menuitem-search?q=qvalia&action=view&participant=iso6523-actorid-upis%3A%3A0007%3A5567321707

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

peppolIdstringRequired

PeppolId for the endpoint, e.g. "0007:9999999999"

Body

descriptionstringOptionalExample: Some PeppolId

Responses

200

application/json

statusstring · enumOptionalPossible values:

peppolIdstringOptionalExample: 0007:9999999999

401

Unauthorized

text/plain

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

put/partner/{partnerRegNo}/account/{accountRegNo}/peppol/{peppolId}

PUT /partner/{partnerRegNo}/account/{accountRegNo}/peppol/{peppolId} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 374

{
  "description": "Some PeppolId",
  "businessCard": {
    "companyName": "Qvalia AB",
    "countryCode": "SE",
    "geographicalInformation": "Stockholm",
    "VAT": "SE556732170701",
    "orgNr": "SE5567321707",
    "suffix": "ABC"
  },
  "docTypes": [
    {
      "profile": "urn:fdc:peppol.eu:poacc:bis:ordering:3",
      "document": "urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:fdc:peppol.eu:poacc:trns:order:3::2.1"
    }
  ]
}

{
  "status": "updated",
  "peppolId": "0007:9999999999"
}

Delete Account Peppol Identifier

delete

/partner/{partnerRegNo}/account/{accountRegNo}/peppol/{peppolId}

An API to DELETE a Peppol identifier to a Qvalia account under your Partner account.

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

peppolIdstringRequired

PeppolId for the endpoint, e.g. "0007:9999999999"

Responses

200

application/json

statusstringOptionalExample: deleted

401

Unauthorized

text/plain

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

delete/partner/{partnerRegNo}/account/{accountRegNo}/peppol/{peppolId}

DELETE /partner/{partnerRegNo}/account/{accountRegNo}/peppol/{peppolId} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": "deleted"
}

Post Partner accounts transactions

post

/partner/{partnerRegNo}/transaction/{accountRegNo}/(message-type)/(direction)

NB! This documented endpoint has a pseudo path URI! (read below)

An API to send (POST) your Partner accounts transactions.

Using the prefix of /partner/{partnerRegNo} you, as a partner, can access your accounts transactions through Qvalia Transaction API.

(message-type) and (direction) attributes in URI refers to Transaction API endpoints, e.g. invoices and incoming, which results in /partner/{partnerRegNo}/transaction/{accountRegNo}/invoices/incoming.

(message-type) and (direction) are interchangable for all Transaction API endpoints, as well as for the read endpoints, by adding the read attribute to the URI.

Refer to documentation for handling transactions at Qvalia Transaction API

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

Responses

200

See https://api.qvalia.io/api-documentation/apis/transaction-api

No content

post/partner/{partnerRegNo}/transaction/{accountRegNo}/(message-type)/(direction)

POST /partner/{partnerRegNo}/transaction/{accountRegNo}/(message-type)/(direction) HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

200

See https://api.qvalia.io/api-documentation/apis/transaction-api

No content

PreviousWebhooks

NextWebhook API

Last updated 20 days ago

Was this helpful?

Get Accounts

Post Account

Important! You must add appFeatures and apiIntegration for the child account to be able to use the API for the child account!

Get Account

Put Account

Important! You must add appFeatures and apiIntegration for the child account to be able to use the API for the child account!

Get Users in Account

Post Account

Get Users in Account

Put Account

Delete User

Get Bankaccounts in Account

Post Bankaccount

Get Bankaccounts in Account

Put Bankaccount

Delete Bankaccount

Get Peppol Identifier

Get Account Peppol Identifiers

Get Account Peppol Identifier

Put Account Peppol Identifier

Peppol Document Types

Add and update through a PUT

Delete Account Peppol Identifier

Post Partner accounts transactions

Important! You must add `appFeatures` and `apiIntegration` for the child account to be able to use the API for the child account!

Important! You must add `appFeatures` and `apiIntegration` for the child account to be able to use the API for the child account!