# Peppol v1-beta
Beta
These endpoints are subject to change.
The beta Peppol endpoints extend the v1 Peppol configuration with a flow on every capability, the
legal country of a party, and two extra layers between your default config and a party: country and
scheme. Delivery options, registration, the business card, migration and unregistering work as in v1.
# Configuration layers
A party resolves its configuration over four layers. The narrowest one that sets something wins: the party itself, then its Peppol scheme, then its country, then your default environment config.
| layer | endpoint | carries |
|---|---|---|
| party | api/v1.0-beta/peppol/config/party/{partyId} | capabilities, verification, businessCard, migration |
| scheme | api/v1.0-beta/peppol/config/scheme/{schemeNumber} | capabilities |
| country | api/v1.0-beta/peppol/config/country/{countryCode} | capabilities |
| default | api/v1.0-beta/peppol/config | capabilities |
Every endpoint takes GET and PUT. The default and party endpoints also exist under api/v1, without
flow and without the verification country code. Country, scheme and default use the
same permissions as the default config, the party layer the same as the party config.
The verification, the business card for the Peppol directory and the migration are only available on
the party layer. The other layers carry capabilities and their flow only.
The country code is the ISO 3166-1 alpha-2 (opens new window) code of the party's country (NL), matched against the
country code the party is registered with. The scheme is its Peppol scheme, given either
as the number or as the scheme text — 0106 and NL:KVK address the same layer.
A GET shows what a layer inherits. A state or flow that comes from the layer above starts with
inherited =>. Send it back unchanged and it stays inherited. A scheme that belongs to one country, such
as 0106 for NL, also inherits from that country.
GET api/v1.0-beta/peppol/config/party/{partyId}
{
"verification": {
"notes": "Contract agreement C21345",
"verifiedOn": "2020-02-03T14:11:17.2750853+00:00",
"countryCode": "NL"
},
"capabilities": {
"invoices": {
"state": "inherited => on",
"description": "BIS Billing V3, BIS Billing V3 CreditNote",
"flow": "inherited => ctc"
}
}
}
A PUT on the scheme or country layer sets what every party of that scheme or country inherits.
PUT api/v1.0-beta/peppol/config/scheme/0245
{
"capabilities": {
"invoices": {
"state": "on",
"flow": "ctc"
}
}
}
Every party of that scheme now receives invoices with the ctc flow enabled, unless the party sets a flow of its own.
# Country code
Verification also takes a countryCode: the country the party is legally registered in, as an
ISO 3166-1 alpha-2 (opens new window) code.
This is not the country on the business card. The business card carries the address where the business is located, which may well be another country. A company registered in Belgium can have its office in the Netherlands. Peppol reporting is filed on the legal country, so that is the one this field holds.
"verification": {
"notes": "Contract agreement C21345",
"verifiedOn": "2020-02-03T14:11:17.2750853+00:00",
"countryCode": "BE"
}
# Flow
A capability can carry a flow, which tells the PSB how documents of that family are routed. Set it to
off to cancel a flow inherited from the layer above.
Leaving flow out of a capability keeps whatever that capability already had. A PUT that sends only
state does not clear a flow set earlier. Send an empty flow to drop it and inherit again.
| value | meaning |
|---|---|
ctc | Continuous transaction control. |
mls | Message level status. |
off | No flow at all, even when a layer above sets one. |
| empty | Inherit whatever the layer above sets. |
Both schemes take optional parameters after a ?, separated by &:
| parameter | meaning |
|---|---|
mlsReplyDelay=<seconds> | Wait this long before acknowledging the sender. |
mlsReply=none | Run the flow, but do not acknowledge the sender. Cannot be combined with mlsReplyDelay. |
taxAuthorityPartyId=<partyId> | The tax authority the documents go to. ctc only. |
"capabilities": {
"invoices": {
"state": "on",
"description": "BIS Billing V3, BIS Billing V3 CreditNote",
"flow": "ctc?mlsReplyDelay=60"
}
}