Biac Peppol

Type document

In order for a company to receive documents through the Peppol network, it is necessary to configure the different types of document that a company can receive.

Add

This action will create an entry point on the biac smp so that each participant can know the documents taken into account by a company.

Request

  • URL : /TypeDocument/{COMPANY_ID}
    • COMPANY_ID: the company id
  • Method : POST
  • Headers:
    • Username: YOUR USERNAME
    • UserPassword: YOUR USERPASSWORD
  • Body:
{
  "identifierValue": "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"
}

Available value

Invoice: "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"

Credit note: "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"

Response

  • Code: 200 OK

You can verify if everithing is ok using this toolsopen in new window by filling the identifier value with the VAT number of the company.

Error Response

  • Code: 401 Unauthorized

Username or UserPassword incorrectly configured or invalid.

  • Code: 400 Bad request
  • Body
No company matching CompanyID : {companyID}

The company does not exist or is not managed by this service provider.

  • Code: 400 Bad request
  • Body:

Document type not allowed

  • Code: 400 Bad request
  • Body:

Document type already managed for this company

Get Available

  • URL : /TypeDocument/Available
  • Method : Get
  • Headers:
    • Username: YOUR USERNAME
    • UserPassword: YOUR USERPASSWORD

Response

[
    "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",
    "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"
]

Return an array of all available document type.

Delete

This action will remove the given document type.

Request

  • URL : /TypeDocument/{COMPANY_ID}
    • COMPANY_ID: the company id
  • Method : DEL
  • Headers:
    • Username: YOUR USERNAME
    • UserPassword: YOUR USERPASSWORD
  • Body:
{
  "identifierValue": "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"
}

Error Response

  • Code: 401 Unauthorized

Username or UserPassword incorrectly configured or invalid.

  • Code: 404 Bad request
  • Body
No company matching CompanyID : {companyID}

The company does not exist or is not managed by this service provider.

  • Code: 400 Bad request
  • Body
Document type not allowed
  • Code: 404 Not found
  • Body
Document type not found for this company
Last Updated: