GitHub - digipost/digipost-data-types: Digipost API data types

Data types

Type	Description
Appointment	Appointment represents a meeting set for a specific place and time
Boligdetaljer	Details about a Residence, and may be joined with Residence to retrieve the core fields of a Residence.
Event	Event represents an event that occurs over a time period or several days. Eg. a conference or an election
ExternalLink	An external URL, along with an optional description and deadline for resources such as a survey.
Inkasso	A debt collection payment
Invoice	An invoice
InvoicePayment	Payment information for an invoice
Payslip	For treating documents as Payslips.
PickupNotice	Details about a pickup notice
PickupNoticeStatus	Updates to status for PickupNotice
Proof	Represents a legal document (Certificate, Licence, Permit, etc.) issued to a single person, valid for one or more time periods.
Receipt	Receipt represents a document containing details about a purchase
Residence	Residence is a way of linking separate data for the same residence
ShareDocumentsRequest	A request for a user to share one or more documents
ShareDocumentsRequestDocumentsShared	Documents have been shared for ShareDocumentsRequest
ShareDocumentsRequestSharingStopped	Stop sharing of documents for ShareDocumentsRequest
SignedDocument	Details about a signed document

Appointment

Appointment represents a meeting set for a specific place and time

Fields

Name	Type	Required	Description
startTime	ZonedDateTime	yes	ISO8601 full DateTime
endTime	ZonedDateTime	no	ISO8601 full DateTime. Default value 30 minutes after startTime
arrivalTime	String	no	Free text but can contain a ISO8601 DateTime. Example: Please arrive 15 minutes early
place	String	no	The name of the place. Example: Oslo City Røntgen
address	Address	no
subTitle	String	no	Example: MR-undersøkelse av høyre kne
info	List	no	Additional sections of information (max 2) with a title and text
language	Language	no	Languange for the document
link	ExternalLink	no	A link to more information, or further actions that can be taken

Appointment.Address

Name	Type	Required	Description
streetAddress	String	no	E.g. Storgata 11
streetAddress2	String	no	E.g. Romerike Næringspark
postalCode	String	no
city	String	no
country	String	no

Appointment.Language

Valid values:

NB
NN
EN

Appointment.ExternalLink

Name	Type	Required	Description
url	URI	yes	Target URL of this link. Must be http or https.
deadline	ZonedDateTime	no	Optional deadline for the user to respond. ISO8601 full DateTime.
description	String	no	A short, optional text-field, describing the external link.
buttonText	String	no	Optional text which will be displayed on the button.

XML

<appointment xmlns="http://api.digipost.no/schema/datatypes">
    <start-time>2017-06-27T10:00:00+02:00</start-time>
    <end-time>2017-06-27T11:00:00+02:00</end-time>
    <arrival-time>Oppmøte senest 15 minutter før timen</arrival-time>
    <place>Oslo City Røntgen</place>
    <address>
        <street-address>Storgata 23</street-address>
        <postal-code>0011</postal-code>
        <city>Oslo</city>
        <country>Norge</country>
    </address>
    <sub-title>Undersøke smerter i ryggen</sub-title>
    <info>
        <title>Informasjon om Oslo City Røntgen</title>
        <text>Oslo City Røntgen er et spesialistsenter for avansert bildediagnostikk.</text>
    </info>
    <language>NB</language>
    <link>
        <url>https://www.oslo.kommune.no/barnehage/svar-pa-tilbud-om-plass/</url>
        <deadline>2017-09-30T13:37:00+02:00</deadline>
        <description>Oslo Kommune ber deg akseptere eller avslå tilbudet om barnehageplass.</description>
        <button-text>Svar på barnehageplass</button-text>
    </link>
</appointment>

Boligdetaljer

Details about a Residence, and may be joined with Residence to retrieve the core fields of a Residence.

Complemented by:

Boligdetaljer

Fields

Name	Type	Required	Description
residence	Residence	yes
hjemmelshavere	List	no	List of people with legal rights associated with the residence
bruksareal	Integer	no	BRA for bolig
antallOppholdsrom	Integer	no	Number of rooms, bathroom, kitchen and storage rooms excluded
antallBaderom	Integer	no	Number of bathrooms
omsetningshistorikk	List	no	Previous sales and transactions
organisasjonsnummer	String	no
bruksenhet	String	no
andelsnummer	String	no
heftelser	List	no
callToAction	ExternalLink	no	An optional ExternalLink prompting the user to perform an action on an external site
language	Language	no	Languange for the document

Boligdetaljer.Residence

Name	Type	Required
address	ResidenceAddress	yes
matrikkel	Matrikkel	no
source	String	no
externalId	String	no

Boligdetaljer.ResidenceAddress

Name	Type	Required	Description
unitNumber	String	no	Bolignummer. Must be of format [UKHL]0000. E.g. H0304
houseNumber	String	no	A house number with or without a house letter. E.g. 11 or 11A
streetName	String	no	The name of the street. E.g. Storgata
postalCode	String	no
city	String	no

Boligdetaljer.Matrikkel

Name	Type	Required
kommunenummer	String	yes
gaardsnummer	String	yes
bruksnummer	String	yes
festenummer	String	no
seksjonsnummer	String	no

Boligdetaljer.ExternalLink

Name	Type	Required	Description
url	URI	yes	Target URL of this link. Must be http or https.
deadline	ZonedDateTime	no	Optional deadline for the user to respond. ISO8601 full DateTime.
description	String	no	A short, optional text-field, describing the external link.
buttonText	String	no	Optional text which will be displayed on the button.

Boligdetaljer.Language

Valid values:

NB
NN
EN

XML

<boligdetaljer xmlns="http://api.digipost.no/schema/datatypes">
    <residence>
        <address>
            <house-number>23</house-number>
            <street-name>Storgata</street-name>
            <postal-code>0011</postal-code>
            <city>Oslo</city>
        </address>
        <matrikkel>
            <kommunenummer>0301</kommunenummer>
            <gaardsnummer>208</gaardsnummer>
            <bruksnummer>630</bruksnummer>
            <festenummer>0</festenummer>
            <seksjonsnummer>0</seksjonsnummer>
        </matrikkel>
        <source>boligmappa</source>
        <external-id>externalId</external-id>
    </residence>
    <hjemmelshavere>
        <name>Gunnar Gunnersen</name>
        <email>[email protected]</email>
    </hjemmelshavere>
    <bruksareal>59</bruksareal>
    <antall-oppholdsrom>3</antall-oppholdsrom>
    <antall-baderom>4</antall-baderom>
    <omsetningshistorikk>
        <dato>2017-07-27T10:00:00+02:00</dato>
        <beskrivelse>Privat salg av sekundærbolig</beskrivelse>
        <selger>Bill Isalg</selger>
        <kjoeper>Cooper Coopersen</kjoeper>
        <beloep>12345678</beloep>
    </omsetningshistorikk>
    <organisasjonsnummer>123456789</organisasjonsnummer>
    <bruksenhet>H1337</bruksenhet>
    <andelsnummer>42</andelsnummer>
    <heftelser>
        <panthaver>TNT ASA</panthaver>
        <type-pant>Pantedokument</type-pant>
        <beloep>3000000000</beloep>
    </heftelser>
    <callToAction>
        <url>https://www.example.com</url>
        <description>Gå til avsenders side for å gjøre en handling</description>
        <button-text>Ta meg til handling!</button-text>
    </callToAction>
    <language>NB</language>
</boligdetaljer>

Event

Event represents an event that occurs over a time period or several days. Eg. a conference or an election

Fields

Name	Type	Required	Description
subTitle	String	no	Example: 'Kommunestyre- og fylkestingvalg'
time	List	yes	List of time intervals
timeLabel	String	no	Optional label for time. null yield default in gui, eg. 'Opening hours'
description	String	no	Free text but can contain a ISO8601 DateTime. Example: 'Please use entrance from street'
place	String	no	The name of the place. Example: 'Sagene skole'
placeLabel	String	no	Optional label for place. null yield default in gui, eg. 'Venue location'
address	Address	no
info	List	no	Additional sections of information (max 10) with a title and text.
barcodeLabel	String	no	Optional label for barcode. null yield default in gui, eg. ''
barcode	Barcode	no	Barcode
links	List	no	Links for releated information to the appointment
language	Language	no	Languange for the document

Event.Address

Name	Type	Required	Description
streetAddress	String	no	E.g. Storgata 11
streetAddress2	String	no	E.g. Romerike Næringspark
postalCode	String	no
city	String	no
country	String	no

Event.Barcode

Name	Type	Required	Description
barcodeValue	String	no	The barcode on this receipt
barcodeType	String	no
barcodeText	String	no	Barcode text can be used to describe the barcode
showValueInBarcode	Boolean	no	If true, the barcode will render its value as part of the image

Event.Language

Valid values:

NB
NN
EN

XML

<event xmlns="http://api.digipost.no/schema/datatypes">
    <sub-title>Kommunestyre- og fylkestingvalg</sub-title>
    <start-time>
        <start-time>2019-05-23T10:00:00+02:00</start-time>
        <end-time>2019-05-23T16:00:00+02:00</end-time>
    </start-time>
    <timeLabel>Opening hours</timeLabel>
    <description>Velkommen til valg! Husk legitimasjon.</description>
    <place>Sagene skole</place>
    <placeLabel>Election venue</placeLabel>
    <address>
        <street-address>Storgata 23</street-address>
        <postal-code>0011</postal-code>
        <city>Oslo</city>
        <country>Norge</country>
    </address>
    <info>
        <title>Forhåndsstemming</title>
        <text>Du kan forhåndsstemme fra 10. august</text>
    </info>
    <barcodeLabel>Barcode for use on election day:</barcodeLabel>
    <barcode>
        <barcode-value>1234567890</barcode-value>
        <barcode-type>code-128</barcode-type>
        <barcode-text>Show barcode for faster identification</barcode-text>
        <show-value-in-barcode>true</show-value-in-barcode>
    </barcode>
    <links>
        <url>https://valg.no</url>
        <description>Les mer om valget på valg.no</description>
    </links>
    <language>NB</language>
</event>

ExternalLink

An external URL, along with an optional description and deadline for resources such as a survey.

Fields

Name	Type	Required	Description
url	URI	yes	Target URL of this link. Must be http or https.
deadline	ZonedDateTime	no	Optional deadline for the user to respond. ISO8601 full DateTime.
description	String	no	A short, optional text-field, describing the external link.
buttonText	String	no	Optional text which will be displayed on the button.

XML

<externalLink xmlns="http://api.digipost.no/schema/datatypes">
    <url>https://www.oslo.kommune.no/barnehage/svar-pa-tilbud-om-plass/</url>
    <deadline>2017-09-30T13:37:00+02:00</deadline>
    <description>Oslo Kommune ber deg akseptere eller avslå tilbudet om barnehageplass.</description>
    <button-text>Svar på barnehageplass</button-text>
</externalLink>

Inkasso

A debt collection payment

Complemented by:

InvoicePayment

Fields

Name	Type	Required	Description
link	ExternalLink	no	A link to more information, or further actions that can be taken
dueDate	ZonedDateTime	yes	When the payment falls due
sum	BigDecimal	no	The sum to be payed
account	String	no	The creditor account for the payment. Exactly 11 digits
kid	String	no	The customer identification number. Max length 25 chars

Inkasso.ExternalLink

Name	Type	Required	Description
url	URI	yes	Target URL of this link. Must be http or https.
deadline	ZonedDateTime	no	Optional deadline for the user to respond. ISO8601 full DateTime.
description	String	no	A short, optional text-field, describing the external link.
buttonText	String	no	Optional text which will be displayed on the button.

XML

<inkasso xmlns="http://api.digipost.no/schema/datatypes">
    <link>
        <url>https://www.example.com</url>
        <description>Gå til avsenders side for å gjøre en handling</description>
        <button-text>Ta meg til handling!</button-text>
    </link>
    <due-date>2019-12-10T00:00:00+01:00</due-date>
    <sum>42</sum>
    <account>01235424320</account>
    <kid>1435025439583420243982723</kid>
</inkasso>

Invoice

An invoice

Complemented by:

InvoicePayment

Fields

Name	Type	Required	Description
link	ExternalLink	no	A link to more information, or further actions that can be taken
dueDate	ZonedDateTime	yes	When the payment falls due
sum	BigDecimal	yes	The sum to be paid
creditorAccount	String	yes	The creditor account for the payment. Exactly 11 digits
kid	String	no	The customer identification number. Max length 25 chars

Invoice.ExternalLink

Name	Type	Required	Description
url	URI	yes	Target URL of this link. Must be http or https.
deadline	ZonedDateTime	no	Optional deadline for the user to respond. ISO8601 full DateTime.
description	String	no	A short, optional text-field, describing the external link.
buttonText	String	no	Optional text which will be displayed on the button.

XML

<invoice xmlns="http://api.digipost.no/schema/datatypes">
    <link>
        <url>https://www.example.com</url>
        <description>Gå til avsenders side for å gjøre en handling</description>
        <button-text>Ta meg til handling!</button-text>
    </link>
    <due-date>2020-09-10T00:00:00+01:00</due-date>
    <sum>42</sum>
    <creditor-account>01235424320</creditor-account>
    <kid>1435025439583420243982723</kid>
</invoice>

InvoicePayment

Payment information for an invoice

Complemented by:

InvoicePayment

Fields

Name	Type	Required	Description
paymentId	String	yes	Unique id to reference the payment with third party
paymentStatus	String	yes	A status a given payment is in. ISO20022 payment statuses can be used
paymentTime	ZonedDateTime	yes	When the payment is done
debtorAccount	String	yes	The debtor account for the payment. Exactly 11 digits
debtorAccountName	String	no	Optional name of the account
paymentChannel	String	yes	Name the third party performing the payment
paymentBank	Bank	yes	The bank payment is registered with

InvoicePayment.Bank

Name	Type	Required	Description
id	String	no	Unique id of the bank to reference the payment with third party
name	String	no	Display name of the bank

XML

<invoice-payment xmlns="http://api.digipost.no/schema/datatypes">
    <payment-id>33aa4572ac1c61d807345c5968ab1fbd</payment-id>
    <payment-status>PDNG</payment-status>
    <payment-time>2020-09-21T00:00:00+01:00</payment-time>
    <debtor-account>01235424320</debtor-account>
    <payment-channel>My pay app</payment-channel>
    <payment-bank>
        <id>ce7ad8ba63d0ea5cd212580192a00156</id>
        <name>Acme Bank inc</name>
    </payment-bank>
</invoice-payment>

Payslip

For treating documents as Payslips.

Fields

Name	Type	Required	Description

XML

<payslip xmlns="http://api.digipost.no/schema/datatypes"/>

PickupNotice

Details about a pickup notice

Complemented by:

PickupNotice, PickupNoticeStatus

Fields

Name	Type	Required	Description
parcelId	String	yes	The id of the parcel in posten
parcelUUID	String	no	The uuid of the parcel
barcode	Barcode	yes	Barcode
productName	String	no	Mail Service product name
arrivalDateTime	ZonedDateTime	yes	ISO8601 full DateTime for arrival at pickup place
returnDateTime	ZonedDateTime	yes	ISO8601 full DateTime for return back to sender
recipient	Recipient	yes	The recipient of the parcel
sender	Sender	no	The sender of the parcel
pickupPlace	PickupPlace	yes	where the parcel can be fetched
thePackage	Package	no	package information
cost	Cost	no	Information about value, mva, customs processing and more
extraInformation	String	no	Additional information about the pickup. May for example be used to inform the recipient that identification will be required upon pickup.
status	Status	no	The state the package is at present time
tags	Set	no	Tags to describe the document
language	Language	no	Language for the document
link	ExternalLink	no	An optional link to an external site, where the recipient can perform additional actions for their package

PickupNotice.Barcode

Name	Type	Required	Description
barcodeValue	String	no	The barcode on this receipt
barcodeType	String	no
barcodeText	String	no	Barcode text can be used to describe the barcode
showValueInBarcode	Boolean	no	If true, the barcode will render its value as part of the image

PickupNotice.Recipient

Name	Type	Required	Description
name	String	no	The name of the recipient
digipostAddress	String	yes	The digipost address for the recipient
address	Address	no

PickupNotice.Address

Name	Type	Required	Description
streetAddress	String	no	E.g. Storgata 11
streetAddress2	String	no	E.g. Romerike Næringspark
postalCode	String	no
city	String	no
country	String	no

PickupNotice.Sender

Name	Type	Required	Description
name	String	no	The senders name
reference	String	no	The senders reference
address	Address	no

PickupNotice.PickupPlace

Name	Type	Required	Description
name	String	yes	The pickup place name
code	String	yes	The pickup code
instruction	String	yes	instructions for fetching the parcel
shelfLocation	String	no	shelf location at pickup point
address	Address	yes

PickupNotice.Package

Name	Type	Required	Description
length	Integer	no	Package lenght in cm
width	Integer	no	Package width in cm
height	Integer	no	Package height in cm
weight	Integer	no	Package weight in grams

PickupNotice.Cost

Name	Type	Required	Description
valueToBePayed	BigDecimal	yes	The value of the parcel in NOK
packageValue	BigDecimal	no	The value of the parcel in NOK
customsFeeOutlayed	BigDecimal	no	payed fee in customs
vasText	String	no	Information about the value added service (vas)
customsFee	BigDecimal	no	Fee payed for customs declaration
customsFeeOutlayCost	BigDecimal	no	Outlay for customs by the service
codAmount	BigDecimal	no	Cash on delivery (cod) amount
codFee	BigDecimal	no	Cash on delivery (cod) fee

PickupNotice.Status

Valid values:

READY_FOR_PICKUP
PICKED_UP
RETURNED
UNKNOWN
DEVIATION

PickupNotice.Language

Valid values:

NB
NN
EN

PickupNotice.ExternalLink

Name	Type	Required	Description
url	URI	yes	Target URL of this link. Must be http or https.
deadline	ZonedDateTime	no	Optional deadline for the user to respond. ISO8601 full DateTime.
description	String	no	A short, optional text-field, describing the external link.
buttonText	String	no	Optional text which will be displayed on the button.

XML

<pickup-notice xmlns="http://api.digipost.no/schema/datatypes">
    <parcel-id>KB432788293NO</parcel-id>
    <parcel-uuid>70300492517312675</parcel-uuid>
    <barcode>
        <barcode-value>1234567890</barcode-value>
        <barcode-type>CODE_128</barcode-type>
        <barcode-text>Show barcode for faster identification</barcode-text>
        <show-value-in-barcode>true</show-value-in-barcode>
    </barcode>
    <product-name>Klimanøytral Servicepakke</product-name>
    <arrival-date-time>2018-09-10T10:00:00+02:00</arrival-date-time>
    <return-date-time>2018-09-24T10:00:00+02:00</return-date-time>
    <recipient>
        <name>Test Testesen</name>
        <digipost-address>test.testesen#0000</digipost-address>
        <address>
            <street-address>Storgata 23</street-address>
            <postal-code>0011</postal-code>
            <city>Oslo</city>
            <country>Norge</country>
        </address>
    </recipient>
    <sender>
        <name>Avsenderservice as</name>
        <reference>13372500</reference>
        <address>
            <street-address>Storgata 23</street-address>
            <postal-code>0011</postal-code>
            <city>Oslo</city>
            <country>Norge</country>
        </address>
    </sender>
    <pickup-place>
        <name>Coop Mega</name>
        <code>RC89</code>
        <instruction>Må hentes innen 010180</instruction>
        <shelf-location>H32</shelf-location>
        <address>
            <street-address>Storgata 23</street-address>
            <postal-code>0011</postal-code>
            <city>Oslo</city>
            <country>Norge</country>
        </address>
    </pickup-place>
    <package>
        <length>120</length>
        <width>60</width>
        <height>60</height>
        <weight>35000</weight>
    </package>
    <cost>
        <value-to-be-payed>128.00</value-to-be-payed>
        <package-value>1277.00</package-value>
        <customs-fee-outlayed>162.00</customs-fee-outlayed>
        <vas-text>FORENKLET TOLLBEHANDLING</vas-text>
        <customs-fee>0</customs-fee>
        <customs-fee-outlay-cost>0</customs-fee-outlay-cost>
        <cod-amount>0</cod-amount>
        <cod-fee>0</cod-fee>
    </cost>
    <extra-information>Krever fremvisning av Pass eller Norsk nasjonalt ID-kort (Show Passport or Norwegian national ID-card). Fullmakt ikke tillatt.</extra-information>
    <status>READY_FOR_PICKUP</status>
    <tags>POSTEN</tags>
    <language>NB</language>
    <link>
        <url>https://www.oslo.kommune.no/barnehage/svar-pa-tilbud-om-plass/</url>
        <deadline>2017-09-30T13:37:00+02:00</deadline>
        <description>Oslo Kommune ber deg akseptere eller avslå tilbudet om barnehageplass.</description>
        <button-text>Svar på barnehageplass</button-text>
    </link>
</pickup-notice>

PickupNoticeStatus

Updates to status for PickupNotice

Fields

Name	Type	Required	Description
status	Status	yes	The status of the PickupNotice
occurrenceDatetime	ZonedDateTime	no	ISO8601 full DateTime for time of occurrence

PickupNoticeStatus.Status

Valid values:

READY_FOR_PICKUP
PICKED_UP
RETURNED
UNKNOWN
DEVIATION

XML

<pickup-notice-status xmlns="http://api.digipost.no/schema/datatypes">
    <status>READY_FOR_PICKUP</status>
    <occurrence-datetime>2019-01-10T10:10:00+01:00</occurrence-datetime>
</pickup-notice-status>

Proof

Represents a legal document (Certificate, Licence, Permit, etc.) issued to a single person, valid for one or more time periods.

Fields

Name	Type	Required	Description
authorizerName	String	no	Name of e.g. the organization issuing this proof
backgroundColor	String	no	#RRGGBB color code
issuedTime	ZonedDateTime	no	The point of time the proof is issued
validPeriod	ValidPeriod	yes	A description of when the proof is valid
proofHolder	ProofHolder	yes
title	String	yes
proofIdName	String	no	A name describing the content of the proofIdValue field
proofIdValue	String	no	A field for extra information identifying this proof, such as a membership number
attribute	List	no	Extra information for the proof, a set of key-value pairs
info	List	no	Extra instructions for the holder of the proof, such as special terms
language	Language	no	Languange for the document

Proof.ValidPeriod

Name	Type	Required	Description
period	Period	no
yearlyRepeatingPeriod	YearlyRepeatingPeriod	no

Proof.Period

Name	Type	Required	Description
from	LocalDateTime	no	ISO8601 full DateTime
to	LocalDateTime	no	ISO8601 full DateTime

Proof.YearlyRepeatingPeriod

Name	Type	Required	Description
startYear	Integer	no
endYear	Integer	no
from	CalendarDate	yes	The date each year the proof becomes valid
to	CalendarDate	yes	The date each year the proof stops being valid

Proof.CalendarDate

Name	Type	Required	Description
month	Integer	yes
day	Integer	yes
hour	Integer	no
min	Integer	no
timeZone	String	no	Deprecated, do not use. Will be ignored.

Proof.ProofHolder

Name	Type	Required
firstName	String	yes
surname	String	yes
socialSecurityNumber	String	no
address	Address	no

Proof.Address

Name	Type	Required	Description
streetAddress	String	no	E.g. Storgata 11
streetAddress2	String	no	E.g. Romerike Næringspark
postalCode	String	no
city	String	no
country	String	no

Proof.Language

Valid values:

NB
NN
EN

XML

<proof xmlns="http://api.digipost.no/schema/datatypes">
    <authorizer-name>Bekkestua Bibliotek</authorizer-name>
    <background-color>#e1e1e1</background-color>
    <issued-time>2019-05-23T10:00:00+02:00</issued-time>
    <valid-period>
        <yearly-repeating-period>
            <start-year>2020</start-year>
            <end-year>2022</end-year>
            <from>
                <month>1</month>
                <day>1</day>
            </from>
            <to>
                <month>12</month>
                <day>31</day>
                <hour>0</hour>
                <min>0</min>
            </to>
        </yearly-repeating-period>
    </valid-period>
    <proof-holder>
        <firstname>Ola</firstname>
        <surname>Nordmann</surname>
        <address>
            <street-address>Storgata 23</street-address>
            <postal-code>0011</postal-code>
            <city>Oslo</city>
            <country>Norge</country>
        </address>
    </proof-holder>
    <title>Lånekort</title>
    <proof-id-name>Lånekortnummer</proof-id-name>
    <proof-id-value>a-132415124-xyzzy-21341</proof-id-value>
    <attribute>
        <title>Kaffeklubb</title>
        <text>Premium deluxe medlem</text>
    </attribute>
    <info>
        <title>Regler</title>
        <text>Det er ikke lov å rive ut sider i bøkene, eller søle med ketchup. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec aliquet urna condimentum, pulvinar neque ac, tempor tellus. Vestibulum ante ipsum primis in faucibus orci luctus et </text>
    </info>
    <language>NB</language>
</proof>

Receipt

Receipt represents a document containing details about a purchase

Fields

Name	Type	Required	Description
receiptId	String	no	The ID of this receipt in the system it was imported from
receiptNumber	String	no	The original receipt number from the store
purchaseTime	ZonedDateTime	yes	When the purchase was made. ISO8601 full DateTime
totalPrice	BigDecimal	yes	The total price paid for the item(s) purchased
totalVat	BigDecimal	yes	The total vat amount for the item(s) purchased
currencyCode	String	no	Currency of the price, ISO4217. Example: NOK
cashier	String	no	Identifier for cashier who made the sale
register	String	no	Identifier for the register where the purchase was made
merchantChain	String	no	Optional name of the chain that the merchant is a part of
merchantName	String	yes	Name of the store or merchant. Example: Grünerløkka Hip Coffee
merchantPhoneNumber	String	no
merchantAddress	Address	no	Address of the store or merchant
organizationNumber	String	no	Organization number of the sales point
barcode	Barcode	no
payments	List	no	List of payments done during this purchase
items	List	no	The individual items sold
taxiDetails	TaxiDetails	no	Details for taxi receipts
customer	Customer	no	Name and address of customer
delivery	Delivery	no	Name and address of delivery
orderNumber	String	no
membershipNumber	String	no
comment	String	no
language	Language	no	Languange for the document

Receipt.Address

Name	Type	Required	Description
streetAddress	String	no	E.g. Storgata 11
streetAddress2	String	no	E.g. Romerike Næringspark
postalCode	String	no
city	String	no
country	String	no

Receipt.Barcode

Name	Type	Required	Description
barcodeValue	String	no	The barcode on this receipt
barcodeType	String	no
barcodeText	String	no	Barcode text can be used to describe the barcode
showValueInBarcode	Boolean	no	If true, the barcode will render its value as part of the image

Receipt.TaxiDetails

Name	Type	Required
carPlateNumber	String	no
license	String	no
orgNumberLicenseHolder	String	no
startTime	ZonedDateTime	no
stopTime	ZonedDateTime	no
tips	BigDecimal	no
totalMeterPrice	BigDecimal	no
totalDistanceBeforeBoardingInMeters	Integer	no
totalDistanceInMeters	Integer	no
totalDistanceWithPassengerInMeters	Integer	no
totalTimeBeforeBoardingInSeconds	Integer	no
totalTimeInSeconds	Integer	no
totalTimeWithPassengerInSeconds	Integer	no
vat	VatDetails	no

Receipt.VatDetails

Name	Type	Required	Description
levels	List	no
sum	BigDecimal	no

Receipt.Customer

Name	Type	Required
name	String	no
address	Address	no
phoneNumber	String	no

Receipt.Delivery

Name	Type	Required
name	String	no
address	Address	no
terms	String	no

Receipt.Language

Valid values:

NB
NN
EN

XML

<receipt xmlns="http://api.digipost.no/schema/datatypes">
    <receiptId>F96B6805-2453-478A-B58B-CCDFA07E21ED</receiptId>
    <receiptNumber>364567</receiptNumber>
    <purchaseTime>2018-05-27T10:00:00+02:00</purchaseTime>
    <totalPrice>59.80</totalPrice>
    <totalVat>11.96</totalVat>
    <currency>NOK</currency>
    <cashier>Benny</cashier>
    <register>15</register>
    <merchant-chain>7F5A1EFF-ECAE-48A7-A07F-38D87576F815</merchant-chain>
    <merchant-name>Grünerløkka Hip Coffee</merchant-name>
    <merchant-phone-number>12345678</merchant-phone-number>
    <merchant-address>
        <street-address>Storgata 23</street-address>
        <postal-code>0011</postal-code>
        <city>Oslo</city>
        <country>Norge</country>
    </merchant-address>
    <orgnumber>123456789</orgnumber>
    <barcode>
        <barcode-value>1234567890</barcode-value>
        <barcode-type>code-128</barcode-type>
        <barcode-text>Show barcode for faster identification</barcode-text>
        <show-value-in-barcode>true</show-value-in-barcode>
    </barcode>
    <payments>
        <type>Bank Axept</type>
        <card-number>************1234</card-number>
        <cardName>Visa</cardName>
        <amount>100.00</amount>
        <currency-code>NOK</currency-code>
        <foreign-currency-payment>
            <currency-code>USD</currency-code>
            <amount>15</amount>
            <exchange-rate>7.534567</exchange-rate>
        </foreign-currency-payment>
    </payments>
    <items>
        <item-name>Tall Cafe latte</item-name>
        <item-description>Tall vanilla latte with extra sugar</item-description>
        <item-code>0000012</item-code>
        <unit>cup</unit>
        <quantity>2.0</quantity>
        <item-price>29.90</item-price>
        <item-vat>5.98</item-vat>
        <total-price>59.80</total-price>
        <total-vat>11.96</total-vat>
        <discount>5.50</discount>
        <serialNumber>XY12345325GF</serialNumber>
        <eanCode>1345678</eanCode>
    </items>
    <taxiDetails>
        <carPlateNumber>EK99999</carPlateNumber>
        <license>12341ASDF</license>
        <orgNumberLicenseHolder>123456789</orgNumberLicenseHolder>
        <startTime>2018-06-05T10:00:00+02:00</startTime>
        <stopTime>2018-06-05T10:30:00+02:00</stopTime>
        <tips>8.00</tips>
        <totalMeterPrice>438.50</totalMeterPrice>
        <totalDistanceBeforeBoardingInMeters>2000</totalDistanceBeforeBoardingInMeters>
        <totalDistanceInMeters>8500</totalDistanceInMeters>
        <totalDistanceWithPassengerInMeters>6500</totalDistanceWithPassengerInMeters>
        <totalTimeBeforeBoardingInSeconds>320</totalTimeBeforeBoardingInSeconds>
        <totalTimeInSeconds>1220</totalTimeInSeconds>
        <totalTimeWithPassengerInSeconds>900</totalTimeWithPassengerInSeconds>
        <vat>
            <levels>
                <grossAmount>400.00</grossAmount>
                <netAmount>320.00</netAmount>
                <vat>80.00</vat>
                <vatPercent>25.00</vatPercent>
            </levels>
            <sum>64.90</sum>
        </vat>
    </taxiDetails>
    <customer>
        <name>Ola Nordmann</name>
        <address>
            <street-address>Storgata 23</street-address>
            <postal-code>0011</postal-code>
            <city>Oslo</city>
            <country>Norge</country>
        </address>
        <phoneNumber>Delivered to the doorstep</phoneNumber>
    </customer>
    <delivery>
        <name>Ola Nordmann</name>
        <address>
            <street-address>Storgata 23</street-address>
            <postal-code>0011</postal-code>
            <city>Oslo</city>
            <country>Norge</country>
        </address>
        <terms>Delivered to the doorstep</terms>
    </delivery>
    <order-number>123456</order-number>
    <membership-number>HG1234HH8778</membership-number>
    <comment>Hip Coffee to the good citizens of Løkka</comment>
    <language>NB</language>
</receipt>

Residence

Residence is a way of linking separate data for the same residence

Fields

Name	Type	Required
address	ResidenceAddress	yes
matrikkel	Matrikkel	no
source	String	no
externalId	String	no

Residence.ResidenceAddress

Name	Type	Required	Description
unitNumber	String	no	Bolignummer. Must be of format [UKHL]0000. E.g. H0304
houseNumber	String	no	A house number with or without a house letter. E.g. 11 or 11A
streetName	String	no	The name of the street. E.g. Storgata
postalCode	String	no
city	String	no

Residence.Matrikkel

Name	Type	Required
kommunenummer	String	yes
gaardsnummer	String	yes
bruksnummer	String	yes
festenummer	String	no
seksjonsnummer	String	no

XML

<residence xmlns="http://api.digipost.no/schema/datatypes">
    <address>
        <house-number>23</house-number>
        <street-name>Storgata</street-name>
        <postal-code>0011</postal-code>
        <city>Oslo</city>
    </address>
    <matrikkel>
        <kommunenummer>0301</kommunenummer>
        <gaardsnummer>208</gaardsnummer>
        <bruksnummer>630</bruksnummer>
        <festenummer>0</festenummer>
        <seksjonsnummer>0</seksjonsnummer>
    </matrikkel>
    <source>boligmappa</source>
    <external-id>externalId</external-id>
</residence>

ShareDocumentsRequest

A request for a user to share one or more documents

Complemented by:

ShareDocumentsRequestSharingStopped

Fields

Name	Type	Required	Description
maxShareDurationSeconds	Long	yes	This is the maximum duration in which you are allowed to access the user's documents from they are shared with you
purpose	String	yes	This text should explain why you need to process the recipient's documents in a short and understandable way.
allowedOriginOrganisationNumbers	Set	no	Only documents received from any of the specified organisations will be possible for the user to share.

XML

<share-documents-request xmlns="http://api.digipost.no/schema/datatypes">
    <max-share-duration-seconds>1209600</max-share-duration-seconds>
    <purpose>We require to see your latest pay slip in order to grant you a loan.</purpose>
    <allowed-origin-organisation-numbers>984661185</allowed-origin-organisation-numbers>
</share-documents-request>

ShareDocumentsRequestDocumentsShared

Documents have been shared for ShareDocumentsRequest

Fields

Name	Type	Required	Description
documentIds	List	no	The IDs of the documents related to this specific event

XML

<share-documents-request-documents-shared xmlns="http://api.digipost.no/schema/datatypes">
    <document-ids>123</document-ids>
</share-documents-request-documents-shared>

ShareDocumentsRequestSharingStopped

Stop sharing of documents for ShareDocumentsRequest

Fields

Name	Type	Required	Description

XML

<share-documents-request-sharing-stopped xmlns="http://api.digipost.no/schema/datatypes"/>

SignedDocument

Details about a signed document

Fields

Name	Type	Required	Description
documentIssuer	String	yes	The original issuer of the document to be signed.
documentSubject	String	yes	The original subject of the document to be signed.
signingTime	ZonedDateTime	yes	When the recipient signed the document. ISO8601 full DateTime.

XML

<signedDocument xmlns="http://api.digipost.no/schema/datatypes">
    <document-issuer>Bedrift AS</document-issuer>
    <document-subject>Ansettelseskontrakt</document-subject>
    <signing-time>2018-07-11T10:00:00+02:00</signing-time>
</signedDocument>

Name		Name	Last commit message	Last commit date
Latest commit History 387 Commits
.github/workflows		.github/workflows
.mvn		.mvn
src		src
.editorconfig		.editorconfig
.gitignore		.gitignore
.gitmodules		.gitmodules
.java-version		.java-version
NOTICE		NOTICE
datatypes-examples.xml		datatypes-examples.xml
datatypes.xsd		datatypes.xsd
pom.xml		pom.xml
readme.md		readme.md

digipost/digipost-data-types

Folders and files

Latest commit

History

Repository files navigation

Data types

Appointment

Fields

Appointment.Address

Appointment.Language

Appointment.ExternalLink

XML

Boligdetaljer

Complemented by:

Fields

Boligdetaljer.Residence

Boligdetaljer.ResidenceAddress

Boligdetaljer.Matrikkel

Boligdetaljer.ExternalLink

Boligdetaljer.Language

XML

Event

Fields

Event.Address

Event.Barcode

Event.Language

XML

ExternalLink

Fields

XML

Inkasso

Complemented by:

Fields

Inkasso.ExternalLink

XML

Invoice

Complemented by:

Fields

Invoice.ExternalLink

XML

InvoicePayment

Complemented by:

Fields

InvoicePayment.Bank

XML

Payslip

Fields

XML

PickupNotice

Complemented by:

Fields

PickupNotice.Barcode

PickupNotice.Recipient

PickupNotice.Address

PickupNotice.Sender

PickupNotice.PickupPlace

PickupNotice.Package

PickupNotice.Cost

PickupNotice.Status

PickupNotice.Language

PickupNotice.ExternalLink

XML

PickupNoticeStatus

Fields

PickupNoticeStatus.Status

XML

Proof

Fields

Proof.ValidPeriod

Proof.Period

Proof.YearlyRepeatingPeriod

Proof.CalendarDate

Proof.ProofHolder

Proof.Address

Proof.Language

XML

Receipt

Fields

Receipt.Address

Receipt.Barcode

Packages