https://github.com/digipost/digipost-data-types
Digipost API data types
https://github.com/digipost/digipost-data-types
Last synced: about 1 month ago
JSON representation
Digipost API data types
- Host: GitHub
- URL: https://github.com/digipost/digipost-data-types
- Owner: digipost
- Created: 2017-06-21T13:26:05.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T09:17:54.000Z (2 months ago)
- Last Synced: 2025-03-23T22:34:20.312Z (about 2 months ago)
- Language: Java
- Size: 572 KB
- Stars: 0
- Watchers: 9
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
## Data types
|Type|Description|
|----|-----------|
|[Appointment](#appointment)|Appointment represents a meeting set for a specific place and time|
|[Boligdetaljer](#boligdetaljer)|Details about a Residence, and may be joined with Residence to retrieve the core fields of a Residence.|
|[Event](#event)|Event represents an event that occurs over a time period or several days. Eg. a conference or an election|
|[ExternalLink](#externallink)|An external URL, along with an optional description and deadline for resources such as a survey.|
|[Inkasso](#inkasso)|A debt collection payment|
|[Invoice](#invoice)|An invoice|
|[InvoicePayment](#invoicepayment)|Payment information for an invoice|
|[OpeningReceipt](#openingreceipt)|To open the document the user must accept to send an opening receipt|
|[OpeningReceiptAccepted](#openingreceiptaccepted)|The document has been opened, and the opening receipt has been accepted and sent.|
|[Payslip](#payslip)|For treating documents as Payslips.|
|[PickupNotice](#pickupnotice)|Details about a pickup notice|
|[PickupNoticeStatus](#pickupnoticestatus)|Updates to status for PickupNotice|
|[Proof](#proof)|Represents a legal document (Certificate, Licence, Permit, etc.) issued to a single person, valid for one or more time periods.|
|[Receipt](#receipt)|Receipt represents a document containing details about a purchase|
|[Residence](#residence)|Residence is a way of linking separate data for the same residence|
|[ShareDocumentsRequest](#sharedocumentsrequest)|A request for a user to share one or more documents|
|[ShareDocumentsRequestDocumentsShared](#sharedocumentsrequestdocumentsshared)|Documents have been shared for ShareDocumentsRequest|
|[ShareDocumentsRequestSharingStopped](#sharedocumentsrequestsharingstopped)|Stop sharing of documents for ShareDocumentsRequest|
|[SignedDocument](#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](#appointmentaddress)|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](#appointmentlanguage)|no|Languange for the document|
|link|[ExternalLink](#appointmentexternallink)|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
```xml
2017-06-27T10:00:00+02:00
2017-06-27T11:00:00+02:00
Oppmøte senest 15 minutter før timen
Oslo City Røntgen
Storgata 23
0011
Oslo
Norge
Undersøke smerter i ryggen
Informasjon om Oslo City Røntgen
Oslo City Røntgen er et spesialistsenter for avansert bildediagnostikk.
NB
https://www.oslo.kommune.no/barnehage/svar-pa-tilbud-om-plass/
2017-09-30T13:37:00+02:00
Oslo Kommune ber deg akseptere eller avslå tilbudet om barnehageplass.
Svar på barnehageplass
```
## Boligdetaljer
Details about a Residence, and may be joined with Residence to retrieve the core fields of a Residence.
### Complemented by:
[Boligdetaljer](#boligdetaljer)
### Fields
|Name|Type|Required|Description|
|----|----|--------|-----------|
|residence|[Residence](#boligdetaljerresidence)|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](#boligdetaljerexternallink)|no|An optional ExternalLink prompting the user to perform an action on an external site|
|language|[Language](#boligdetaljerlanguage)|no|Languange for the document|
### Boligdetaljer.Residence
|Name|Type|Required|Description|
|----|----|--------|-----------|
|address|[ResidenceAddress](#boligdetaljerresidenceaddress)|yes||
|matrikkel|[Matrikkel](#boligdetaljermatrikkel)|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|Description|
|----|----|--------|-----------|
|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
```xml
23
Storgata
0011
Oslo
0301
208
630
0
0
boligmappa
externalId
Gunnar Gunnersen
[email protected]
59
3
4
2017-07-27T10:00:00+02:00
Privat salg av sekundærbolig
Bill Isalg
Cooper Coopersen
12345678
123456789
H1337
42
TNT ASA
Pantedokument
3000000000
https://www.example.com
Gå til avsenders side for å gjøre en handling
Ta meg til handling!
NB
```
## 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](#eventaddress)|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](#eventbarcode)|no|Barcode|
|links|List|no|Links for releated information to the appointment|
|language|[Language](#eventlanguage)|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
```xml
Kommunestyre- og fylkestingvalg
2019-05-23T10:00:00+02:00
2019-05-23T16:00:00+02:00
Opening hours
Velkommen til valg! Husk legitimasjon.
Sagene skole
Election venue
Storgata 23
0011
Oslo
Norge
Forhåndsstemming
Du kan forhåndsstemme fra 10. august
Barcode for use on election day:
1234567890
code-128
Show barcode for faster identification
true
https://valg.no
Les mer om valget på valg.no
NB
```
## 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
```xml
https://www.oslo.kommune.no/barnehage/svar-pa-tilbud-om-plass/
2017-09-30T13:37:00+02:00
Oslo Kommune ber deg akseptere eller avslå tilbudet om barnehageplass.
Svar på barnehageplass
```
## Inkasso
A debt collection payment
### Complemented by:
[InvoicePayment](#invoicepayment)
### Fields
|Name|Type|Required|Description|
|----|----|--------|-----------|
|link|[ExternalLink](#inkassoexternallink)|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
```xml
https://www.example.com
Gå til avsenders side for å gjøre en handling
Ta meg til handling!
2019-12-10T00:00:00+01:00
42
01235424320
1435025439583420243982723
```
## Invoice
An invoice
### Complemented by:
[InvoicePayment](#invoicepayment)
### Fields
|Name|Type|Required|Description|
|----|----|--------|-----------|
|link|[ExternalLink](#invoiceexternallink)|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
```xml
https://www.example.com
Gå til avsenders side for å gjøre en handling
Ta meg til handling!
2020-09-10T00:00:00+01:00
42
01235424320
1435025439583420243982723
```
## InvoicePayment
Payment information for an invoice
### Complemented by:
[InvoicePayment](#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](#invoicepaymentbank)|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
```xml
33aa4572ac1c61d807345c5968ab1fbd
PDNG
2020-09-21T00:00:00+01:00
01235424320
My pay app
ce7ad8ba63d0ea5cd212580192a00156
Acme Bank inc
```
## Payslip
For treating documents as Payslips.
### Fields
|Name|Type|Required|Description|
|----|----|--------|-----------|
### XML
```xml
```
## PickupNotice
Details about a pickup notice
### Complemented by:
[PickupNotice](#pickupnotice), [PickupNoticeStatus](#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](#pickupnoticebarcode)|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](#pickupnoticerecipient)|yes|The recipient of the parcel|
|sender|[Sender](#pickupnoticesender)|no|The sender of the parcel|
|pickupPlace|[PickupPlace](#pickupnoticepickupplace)|yes|where the parcel can be fetched|
|thePackage|[Package](#pickupnoticepackage)|no|package information|
|cost|[Cost](#pickupnoticecost)|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](#pickupnoticestatus)|no|The state the package is at present time|
|tags|Set|no|Tags to describe the document|
|language|[Language](#pickupnoticelanguage)|no|Language for the document|
|link|[ExternalLink](#pickupnoticeexternallink)|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](#pickupnoticeaddress)|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](#pickupnoticeaddress)|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](#pickupnoticeaddress)|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
```xml
KB432788293NO
70300492517312675
1234567890
CODE_128
Show barcode for faster identification
true
Klimanøytral Servicepakke
2018-09-10T10:00:00+02:00
2018-09-24T10:00:00+02:00
Test Testesen
test.testesen#0000
Storgata 23
0011
Oslo
Norge
Avsenderservice as
13372500
Storgata 23
0011
Oslo
Norge
Coop Mega
RC89
Må hentes innen 010180
H32
Storgata 23
0011
Oslo
Norge
120
60
60
35000
128.00
1277.00
162.00
FORENKLET TOLLBEHANDLING
0
0
0
0
Krever fremvisning av Pass eller Norsk nasjonalt ID-kort (Show Passport or Norwegian national ID-card). Fullmakt ikke tillatt.
READY_FOR_PICKUP
POSTEN
NB
https://www.oslo.kommune.no/barnehage/svar-pa-tilbud-om-plass/
2017-09-30T13:37:00+02:00
Oslo Kommune ber deg akseptere eller avslå tilbudet om barnehageplass.
Svar på barnehageplass
```
## PickupNoticeStatus
Updates to status for PickupNotice
### Fields
|Name|Type|Required|Description|
|----|----|--------|-----------|
|status|[Status](#pickupnoticestatusstatus)|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
```xml
READY_FOR_PICKUP
2019-01-10T10:10:00+01:00
```
## 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](#proofvalidperiod)|yes|A description of when the proof is valid|
|proofHolder|[ProofHolder](#proofproofholder)|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](#prooflanguage)|no|Languange for the document|
### Proof.ValidPeriod
|Name|Type|Required|Description|
|----|----|--------|-----------|
|period|[Period](#proofperiod)|no||
|yearlyRepeatingPeriod|[YearlyRepeatingPeriod](#proofyearlyrepeatingperiod)|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](#proofcalendardate)|yes|The date each year the proof becomes valid|
|to|[CalendarDate](#proofcalendardate)|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|Description|
|----|----|--------|-----------|
|firstName|String|yes||
|surname|String|yes||
|socialSecurityNumber|String|no||
|address|[Address](#proofaddress)|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
```xml
Bekkestua Bibliotek
#e1e1e1
2019-05-23T10:00:00+02:00
2020
2022
1
1
12
31
0
0
Ola
Nordmann
Storgata 23
0011
Oslo
Norge
Lånekort
Lånekortnummer
a-132415124-xyzzy-21341
Kaffeklubb
Premium deluxe medlem
Regler
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
NB
```
## 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](#receiptaddress)|no|Address of the store or merchant|
|organizationNumber|String|no|Organization number of the sales point|
|barcode|[Barcode](#receiptbarcode)|no||
|payments|List|no|List of payments done during this purchase|
|items|List|no|The individual items sold|
|taxiDetails|[TaxiDetails](#receipttaxidetails)|no|Details for taxi receipts|
|customer|[Customer](#receiptcustomer)|no|Name and address of customer|
|delivery|[Delivery](#receiptdelivery)|no|Name and address of delivery|
|orderNumber|String|no||
|membershipNumber|String|no||
|comment|String|no||
|language|[Language](#receiptlanguage)|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|Description|
|----|----|--------|-----------|
|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](#receiptvatdetails)|no||
### Receipt.VatDetails
|Name|Type|Required|Description|
|----|----|--------|-----------|
|levels|List|no||
|sum|BigDecimal|no||
### Receipt.Customer
|Name|Type|Required|Description|
|----|----|--------|-----------|
|name|String|no||
|address|[Address](#receiptaddress)|no||
|phoneNumber|String|no||
### Receipt.Delivery
|Name|Type|Required|Description|
|----|----|--------|-----------|
|name|String|no||
|address|[Address](#receiptaddress)|no||
|terms|String|no||
### Receipt.Language
Valid values:
* NB
* NN
* EN
### XML
```xml
F96B6805-2453-478A-B58B-CCDFA07E21ED
364567
2018-05-27T10:00:00+02:00
59.80
11.96
NOK
Benny
15
7F5A1EFF-ECAE-48A7-A07F-38D87576F815
Grünerløkka Hip Coffee
12345678
Storgata 23
0011
Oslo
Norge
123456789
1234567890
code-128
Show barcode for faster identification
true
Bank Axept
************1234
Visa
100.00
NOK
USD
15
7.534567
Tall Cafe latte
Tall vanilla latte with extra sugar
0000012
cup
2.0
29.90
5.98
59.80
11.96
5.50
XY12345325GF
1345678
EK99999
12341ASDF
123456789
2018-06-05T10:00:00+02:00
2018-06-05T10:30:00+02:00
8.00
438.50
2000
8500
6500
320
1220
900
400.00
320.00
80.00
25.00
64.90
Ola Nordmann
Storgata 23
0011
Oslo
Norge
Delivered to the doorstep
Ola Nordmann
Storgata 23
0011
Oslo
Norge
Delivered to the doorstep
123456
HG1234HH8778
Hip Coffee to the good citizens of Løkka
NB
```
## Residence
Residence is a way of linking separate data for the same residence
### Fields
|Name|Type|Required|Description|
|----|----|--------|-----------|
|address|[ResidenceAddress](#residenceresidenceaddress)|yes||
|matrikkel|[Matrikkel](#residencematrikkel)|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|Description|
|----|----|--------|-----------|
|kommunenummer|String|yes||
|gaardsnummer|String|yes||
|bruksnummer|String|yes||
|festenummer|String|no||
|seksjonsnummer|String|no||
### XML
```xml
23
Storgata
0011
Oslo
0301
208
630
0
0
boligmappa
externalId
```
## ShareDocumentsRequest
A request for a user to share one or more documents
### Complemented by:
[ShareDocumentsRequestSharingStopped](#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
```xml
1209600
We require to see your latest pay slip in order to grant you a loan.
984661185
```
## 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
```xml
123
```
## ShareDocumentsRequestSharingStopped
Stop sharing of documents for ShareDocumentsRequest
### Fields
|Name|Type|Required|Description|
|----|----|--------|-----------|
### XML
```xml
```
```
## OpeningReceipt
To open the document the user must accept to send an opening receipt
### Complemented by:
[OpeningReceiptAccepted](#openingreceiptaccepted)
### Fields
|Name|Type|Required|Description|
|----|----|--------|-----------|
|group|String|yes|This is the group identifier for the opening receipt|
### XML
```xml
aarsoppgave-bedriftAS-2025
```
## OpeningReceiptAccepted
The document has been opened, and the opening receipt has been accepted and sent.
### Fields
|Name|Type|Required|Description|
|----|----|--------|-----------|
### XML
```xml
```
## 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
```xml
Bedrift AS
Ansettelseskontrakt
2018-07-11T10:00:00+02:00
```