Biac Peppol

Company

If you are a software publisher wishing to manage several companies, we offer different endpoints to manage these companies.

Get all

Returns an array of object containing all the company managed by the specified account.

Request

  • URL : /company
  • Method : GET
  • Headers:
    • Username: YOUR USERNAME
    • UserPassword: YOUR USERPASSWORD

Response

[
  {
    "companyId": "BIACLOGTEST",
    "endpointId": "BIACLOGTEST",
    "schemeId": "9938",
    "name": "BIAC Log SA",
    "contact": "test@biaclog.lu",
    "created": "2022-08-23T11:56:22.680176",
    "authorizedMailForSend": "test@biaclog.lu",
    "statusMailIfSuccess": true,
    "statusMailIfFailed": true
  }
]

Get by ID

Returns informations about a specified company.

Request

  • URL : /company/{companyId}
  • Method : GET
  • Headers:
    • Username: YOUR USERNAME
    • UserPassword: YOUR USERPASSWORD

Response

{
    "managedDocumentTypes": [
        "urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1",
        "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1"
    ],
    "companyId": "BIACLOGTEST",
    "endpointId": "BIACLOGTEST",
    "schemeId": "9938",
    "name": "BIAC Log SA",
    "contact": "test@biaclog.lu",
    "created": "2022-08-23T11:56:22.680176",
    "authorizedMailForSend": "test@biaclog.lu",
    "statusMailIfSuccess": true,
    "statusMailIfFailed": true
}

Create

Request

  • URL : /company/
  • Method : POST
  • Headers:
    • Username: YOUR USERNAME
    • UserPassword: YOUR USERPASSWORD
  • Body:
{
  "companyId": "LU18635679",
  "endpointId": "LU18635679",
  "schemeId": "9938",
  "name": "BIAC Log SA",
  "contact": "mail@biaclog.lu",
  "AuthorizedMailForSend": "mailSender@biaclog.lu",
  "StatusMailIfSuccess": true,
  "StatusMailIfFailed": true
}
  • companyId: The company VAT number, this id is used to verify that the issuing company declared in the UBL document is the same as the company linked to the apiKey used to send the document.
  • endpointIdopen in new window: Identifies the Seller's electronic address to which the application level response to the invoice may be delivered.
  • schemeIdopen in new window: The identification scheme identifier of the Seller electronic address (codelistopen in new window)
  • name: the full name of the company.
  • contact: a contact email address for the company.

ONLY USE FOR EMAIL PROCESS

  • AuthorizedMailForSend: The email address who is allowed to send document by email.
  • StatusMailIfSuccess: If true, a status email will be sent in case of success.
  • StatusMailIfFailed: If true, a status email will be sent in case of error.

Success Response

  • Code : 200 OK

If everything is good, there's the api key in the content of the response.

Response content

ApiKey

Error Response

  • Code: 400 Bad request

They are an error on the body of the request or company already exist. Watch the response string for more details.

  • Code: 401 Unauthorized

Username or UserPassword incorrectly configured or invalid.

Update

  • URL : /company/
  • Method : PUT
  • Headers:
    • Username: YOUR USERNAME
    • UserPassword: YOUR USERPASSWORD
  • Body:
{
  "companyId": "LU18635679",
  "endpointId": "LU18635679",
  "schemeId": "9938",
  "name": "BIAC Log SA",
  "contact": "mail@biaclog.lu",
  //This field are only used for sending UBL by the email process rather than by API
  "AuthorizedMailForSend": "mailSender@biaclog.lu",
  "StatusMailIfSuccess": false,
  "StatusMailIfFailed": false
}

Success Response

  • Code : 200 OK

If everything is good, there's no content on the response.

Error Response

  • Code: 400 Bad request

They are an error on the body of the request or company not exist. Watch the response string for more details.

  • Code: 401 Unauthorized

Username or UserPassword incorrectly configured or invalid.

Delete

  • URL : /company/{companyID}
  • Method : DELETE
  • Headers:
    • Username: YOUR USERNAME
    • UserPassword: YOUR USERPASSWORD

Success Response

  • Code : 200 OK

If everything is good, there's no content on the response.

Error Response

  • Code: 400 Bad request

No company found with this id.

  • Code: 401 Unauthorized

Username or UserPassword incorrectly configured or invalid.

Regenerate ApiKey

Allows to regenerate a company api key

  • URL : /company/{companyID}/RegenerateApiKey
  • Method : POST
  • Headers:
    • Username: YOUR USERNAME
    • UserPassword: YOUR USERPASSWORD

Success

  • Code: 200 OK
  • body:
<THE NEW API KEY>
Last Updated: