Web Service: submitter-service

Port type submitter-service-port-typeSource code

1. addInvoices
   Source code
   Description:
   Creates an invoice that is to be displayed in the online bank
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://efaktura-services.nets.no/efaktura-submitter-service/v1/addInvoices
   Input:
   addInvoices (soap:body, use = literal)Source code
   addInvoices type AddInvoices

   To get a status for the consignment and invoices use the getConsignmentStatus and getInvoiceStatus
   calls.
   Possible validation error codes from operation:
   209 - Duplicate consignmentId (Sender has used this consignmentId before)

   • auditInformation type AuditInformationType
     Information used for auditing and logging
     • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
       A unique identifier for a request/response message pair used for logging
   • senderInfo type SenderInfoType
     • consignmentId - optional; type consignmentIdType - type string with restriction maxLength(11) minLength(9) pattern([0-9]{9,11})
       consignmetId is optional for single invoice shipments
     • commissionId - optional; type commissionIdType - type string with restriction maxLength(12) minLength(12) pattern([0-9]{12})
       commissionId is optional and are generated automatically if not set.
       This value serves no use for external parties and can safely be omitted.
     • contentProviderId type providerIdType - type string with restriction minLength(9) maxLength(9) pattern([0-9]{9})
       Id of the issuer
     • batchReference - optional; type batchReferenceType - type string with restriction minLength(0) maxLength(255)
       Free format text used to identify the original inbound consignment in case of forwarding
   • invoices type InvoicesType
     Represents an invoice. Allows up to a 1000 invoices per consignment.
     • invoice type InvoiceType
       • invoiceId type invoiceReferenceType - type string with restriction maxLength(100) minLength(1) pattern([.-_a-zA-Z0-9\-:{}]+)
         Unique character invoice reference
       • A choice of one of the following elements:
       • efakturaIdentifier type efakturaIdentifierType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
         The efakturaIdentifier of the receiver - a unique identifier for the receiver
       • socialSecurityNumber type socialSecurityNumberType - type string with restriction maxLength(11) minLength(11) pattern([0-9]{11})
         The social security number of the receiver.
       • eFakturaReference type eFakturaReferenceType - type string with restriction maxLength(32)
         The customer agreement reference (eFakturareferanse) of the receiver,
         used in the agreement between invoice issuer and receiver (JTTB)
       • kid - optional; type kidType - type string with restriction maxLength(25) minLength(2) pattern(\d+-?)
         KID
       • dueDate type date
       • amount type simpleAmountType - type decimal with restriction fractionDigits(2) minInclusive(0.00)
         The amount represented as a number with two decimals. Must not be negative
       • minimumAmount - optional; type simpleAmountType - type decimal with restriction fractionDigits(2) minInclusive(0.00)
         The amount represented as a number with two decimals. Must not be negative
       • accountNumber type accountNumberType - type string with restriction minLength(11) maxLength(11) pattern([0-9]{11})
         The account the amount should be payed to
       • brandName type brandNameType - type string with restriction maxLength(150)
         Name that is shown to the receiver of the invoice
       • invoiceUrl type invoiceUrlType - type string with restriction maxLength(255) minLength(1)
         URL to where the invoice is located
       • documentType type documentType - type string with restriction - enum { 'EFAKTURA', 'AVTALEGIRO' }
       • invoiceDocumentType - optional; type invoiceDocumentType - type string with restriction - enum { 'INVOICE', 'REMINDER', 'CREDIT_NOTE', 'COLLECTION_NOTICE', 'DUNNING', 'PAYMENT_REQUEST', 'ENFORCEMENT_WARNING' }
       • invoiceNumber - optional; type invoiceNumberType - type string with restriction maxLength(255)
         The issuer invoice-number, ERP-/accounting-system generated sequence.
   Output:
   addInvoicesResponse (soap:body, use = literal)Source code
   addInvoicesResponse type AddInvoicesResponse

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   • noOfInvoices type invoiceCountType - type int with restriction
     The number of invoices received
   Fault:
   validationFault (soap:fault, use = literal)Source code
   validationFault type ValidationFault

   Indicates that the client has sent an invalid request.

   • errorCode type errorCodeType - type int with restriction minInclusive(200) maxExclusive(299)
   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   Fault:
   serverFault (soap:fault, use = literal)Source code
   serverFault type ServerFault

   Indicates an internal server error.

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
2. cancelConsignment
   Source code
   Description:
   Cancel all invoices in a consignment
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://efaktura-services.nets.no/efaktura-submitter-service/v1/cancelConsignment
   Input:
   cancelConsignment (soap:body, use = literal)Source code
   cancelConsignment type CancelConsignment

   Possible validation error codes from operation:
   201 - Unable to find consignment.
   202 - Multiple consignments found for id
   205 - Consignment already cancelled

   • auditInformation type AuditInformationType
     Information used for auditing and logging
     • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
       A unique identifier for a request/response message pair used for logging
   • consignmentId type consignmentIdType - type string with restriction maxLength(11) minLength(9) pattern([0-9]{9,11})
     Unique 11 digit consignment reference (classic b2c)
   Output:
   cancelConsignmentResponse (soap:body, use = literal)Source code
   cancelConsignmentResponse type CancelConsignmentResponse

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   Fault:
   validationFault (soap:fault, use = literal)Source code
   validationFault type ValidationFault

   Indicates that the client has sent an invalid request.

   • errorCode type errorCodeType - type int with restriction minInclusive(200) maxExclusive(299)
   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   Fault:
   serverFault (soap:fault, use = literal)Source code
   serverFault type ServerFault

   Indicates an internal server error.

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
3. cancelInvoice
   Source code
   Description:
   Cancel spesific invoices in a consignment
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://efaktura-services.nets.no/efaktura-submitter-service/v1/cancelInvoice
   Input:
   cancelInvoice (soap:body, use = literal)Source code
   cancelInvoice type CancelInvoice

   Possible validation error codes from operation
   203 - Multiple invoices found for id
   204 - Unable to find invoice
   206 - Invoice already cancelled

   • auditInformation type AuditInformationType
     Information used for auditing and logging
     • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
       A unique identifier for a request/response message pair used for logging
   • consignmentId type consignmentIdType - type string with restriction maxLength(11) minLength(9) pattern([0-9]{9,11})
     Unique 11 digit consignment reference (classic b2c)
   • invoiceId type invoiceReferenceType - type string with restriction maxLength(100) minLength(1) pattern([.-_a-zA-Z0-9\-:{}]+)
     Unique character invoice reference
   Output:
   cancelInvoiceResponse (soap:body, use = literal)Source code
   cancelInvoiceResponse type CancelInvoiceResponse

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   Fault:
   validationFault (soap:fault, use = literal)Source code
   validationFault type ValidationFault

   Indicates that the client has sent an invalid request.

   • errorCode type errorCodeType - type int with restriction minInclusive(200) maxExclusive(299)
   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   Fault:
   serverFault (soap:fault, use = literal)Source code
   serverFault type ServerFault

   Indicates an internal server error.

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
4. cancelSingleInvoice
   Source code
   Description:
   Cancel a single consignment independent invoice.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://efaktura-services.nets.no/efaktura-submitter-service/v1/cancelSingleInvoice
   Input:
   cancelSingleInvoice (soap:body, use = literal)Source code
   cancelSingleInvoice type CancelSingleInvoice

   Possible validation error codes from operation
   203 - Multiple invoices found for issuer id
   204 - Unable to find invoice
   206 - Invoice already cancelled

   • auditInformation type AuditInformationType
     Information used for auditing and logging
     • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
       A unique identifier for a request/response message pair used for logging
   • contentproviderOrgnumber type providerIdType - type string with restriction minLength(9) maxLength(9) pattern([0-9]{9})
     Id of the issuer
   • contentproviderInvoiceId type invoiceReferenceType - type string with restriction maxLength(100) minLength(1) pattern([.-_a-zA-Z0-9\-:{}]+)
     Unique character invoice reference
   Output:
   cancelInvoiceResponse (soap:body, use = literal)Source code
   cancelInvoiceResponse type CancelInvoiceResponse

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   Fault:
   validationFault (soap:fault, use = literal)Source code
   validationFault type ValidationFault

   Indicates that the client has sent an invalid request.

   • errorCode type errorCodeType - type int with restriction minInclusive(200) maxExclusive(299)
   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   Fault:
   serverFault (soap:fault, use = literal)Source code
   serverFault type ServerFault

   Indicates an internal server error.

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
5. getAddedInvoiceValidation
   Source code
   Description:
   Check processing status for one posted invoice, returns the full document rejection if so.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://efaktura-services.nets.no/efaktura-submitter-service/v1/getAddedInvoiceValidation
   Input:
   invoiceLogicalIdentity (soap:body, use = literal)Source code
   invoiceLogicalIdentity type InvoiceLogicalIdentityType

   MPS internal for now. To identift a single one invoice added, identified uniqly by invoiceNumber and serviceProvider (consignmentId for compatibility and use with backend system).

   • auditInformation type AuditInformationType
     Information used for auditing and logging
     • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
       A unique identifier for a request/response message pair used for logging
   • serviceProvider type providerIdType - type string with restriction minLength(9) maxLength(9) pattern([0-9]{9})
     Id of the issuer
   • consignmentId - optional; type consignmentIdType - type string with restriction maxLength(11) minLength(9) pattern([0-9]{9,11})
     Unique 11 digit consignment reference (classic b2c)
   • invoiceNumber type invoiceReferenceType - type string with restriction maxLength(100) minLength(1) pattern([.-_a-zA-Z0-9\-:{}]+)
     Unique character invoice reference
   Output:
   getAddedInvoiceValidationResponse (soap:body, use = literal)Source code
   getAddedInvoiceValidationResponse type GetAddedInvoiceValidationResponse

   MPS internal for now. Contains status for a single invoice added. Reject attribute populated when status is REJECTED only.

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   • invoiceStatus type invoiceStatusType - type string with restriction - enum { 'ACCEPTED', 'REJECTED', 'NOT_FOUND', 'CANCELLED' }
   • invoiceId type invoiceReferenceType - type string with restriction maxLength(100) minLength(1) pattern([.-_a-zA-Z0-9\-:{}]+)
     Unique character invoice reference
   • rejectionDetails type string
   • rejectReasonCode type rejectReasonCodeType - type string with restriction maxLength(3)
     The status code for the rejected invoice. Only filled out for rejected invoices
   • rejectReason type rejectReasonType - type string with restriction maxLength(40)
     The reason the invoice was rejected. Only filled out for rejected invoices
   • rejectedAttribute type rejectedAttributeType - type string with restriction maxLength(50)
     The named attribute causing the invoice rejection. Only filled out for rejected invoices
   • rejectedAttributeValue type rejectedAttributeValueType - type string with restriction maxLength(250)
     The named attributes value causing the invoice rejection. Only filled out for rejected invoices
   Fault:
   validationFault (soap:fault, use = literal)Source code
   validationFault type ValidationFault

   Indicates that the client has sent an invalid request.

   • errorCode type errorCodeType - type int with restriction minInclusive(200) maxExclusive(299)
   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   Fault:
   serverFault (soap:fault, use = literal)Source code
   serverFault type ServerFault

   Indicates an internal server error.

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
6. getBlackList
   Source code
   Description:
   get BlackListed invoice issuers
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://efaktura-services.nets.no/efaktura-submitter-service/v1/getBlackList
   Input:
   getBlackList (soap:body, use = literal)Source code
   getBlackList type GetBlackList

   Request a list of black listed issuers

   • auditInformation type AuditInformationType
     Information used for auditing and logging
     • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
       A unique identifier for a request/response message pair used for logging
   Output:
   getBlackListResponse (soap:body, use = literal)Source code
   getBlackListResponse type GetBlackListResponse

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   • blackListResponses type BlackListResponsesType
     • blackListResponseType - optional; type BlackListResponseType
       • identifier type string
       • identifierType type string
       • status type string
       • activationDate type date
       • deActivationDate - optional; type date
       • blackListType type string
     List of BlackListed invoice issuers
   Fault:
   validationFault (soap:fault, use = literal)Source code
   validationFault type ValidationFault

   Indicates that the client has sent an invalid request.

   • errorCode type errorCodeType - type int with restriction minInclusive(200) maxExclusive(299)
   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   Fault:
   serverFault (soap:fault, use = literal)Source code
   serverFault type ServerFault

   Indicates an internal server error.

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
7. getConsignmentStatus
   Source code
   Description:
   Get status on consignment
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://efaktura-services.nets.no/efaktura-submitter-service/v1/getConsignmentStatus
   Input:
   getConsignmentStatus (soap:body, use = literal)Source code
   getConsignmentStatus type GetConsignmentStatus

   Possible validation error codes from operation
   201 - Unable to find consignment
   202 - Multiple consignments found for id

   • auditInformation type AuditInformationType
     Information used for auditing and logging
     • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
       A unique identifier for a request/response message pair used for logging
   • consignmentId type consignmentIdType - type string with restriction maxLength(11) minLength(9) pattern([0-9]{9,11})
     Unique 11 digit consignment reference (classic b2c)
   Output:
   getConsignmentStatusResponse (soap:body, use = literal)Source code
   getConsignmentStatusResponse type GetConsignmentStatusResponse

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   • status type consignmentStatusType - type string with restriction - enum { 'IN_PROGRESS', 'DONE', 'STOPPED' }
   • acceptedInvoiceCount type long
   • rejectedInvoiceCount type long
   • cancelledInvoiceCount type long
   • rejectedInvoices - optional; type RejectedInvoicesType
     • rejectedInvoice - optional; type RejectedInvoiceType
       • invoiceId type invoiceReferenceType - type string with restriction maxLength(100) minLength(1) pattern([.-_a-zA-Z0-9\-:{}]+)
         Unique character invoice reference
       • rejectReason type rejectReasonType - type string with restriction maxLength(40)
         The reason the invoice was rejected. Only filled out for rejected invoices
       • rejectReasonCode type rejectReasonCodeType - type string with restriction maxLength(3)
         The status code for the rejected invoice. Only filled out for rejected invoices
       • rejectedAttribute - optional; type rejectedAttributeType - type string with restriction maxLength(50)
         The named attribute causing the invoice rejection. Only filled out for rejected invoices
       • rejectedAttributeValue - optional; type rejectedAttributeValueType - type string with restriction maxLength(250)
         The named attributes value causing the invoice rejection. Only filled out for rejected invoices
     List of rejected invoices.
   • cancelledInvoices - optional; type CancelledInvoicesType
     • cancelledInvoice - optional; type CancelledInvoiceType
       • invoiceId type invoiceReferenceType - type string with restriction maxLength(100) minLength(1) pattern([.-_a-zA-Z0-9\-:{}]+)
         Unique character invoice reference
     List of cancelled invoices.
   Fault:
   validationFault (soap:fault, use = literal)Source code
   validationFault type ValidationFault

   Indicates that the client has sent an invalid request.

   • errorCode type errorCodeType - type int with restriction minInclusive(200) maxExclusive(299)
   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   Fault:
   serverFault (soap:fault, use = literal)Source code
   serverFault type ServerFault

   Indicates an internal server error.

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
8. getEfakturaIdentifiers
   Source code
   Description:
   Returns efakturaIdentifier and auto accept agreement if the receiver is found by efaktura identifier, personalnumber, organization number, phone, email, name, or address.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://efaktura-services.nets.no/efaktura-submitter-service/v1/getEfakturaIdentifiers
   Input:
   getEfakturaIdentifiers (soap:body, use = literal)Source code
   getEfakturaIdentifiers type GetEfakturaIdentifiers

   • auditInformation type AuditInformationType
     Information used for auditing and logging
     • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
       A unique identifier for a request/response message pair used for logging
   • getEfakturaIdentifiersKey type EfakturaIdentifiersKeyType
     Contains a set of keys used to search for unique receivers to get the efaktura identifier. Allows for search up to a 1000 receivers.
     • efakturaIdentifierKey type EfakturaIdentifierKeyType
       Contains the keys used to search for a unique receiver to get the efaktura identifier.
       The following rules apply:
       1. Search can be made on social security number, organization number, efaktura identifier or eFakturaReferenceAndContentProvider as single key.
       2. If email alias or phone alias or date of birth is provided at least two of them must match
       3. If only one of date of birth, email alias or phone alias is provided, one of either name, address or
       postal code must match.
       4. If none of date of birth, email alias or phone alias is given all of name, address and postal code must match.
       5. For name and address it is allowed for search where the text is a part of the given field
       6. First and last name is also to be switched, meaning a first name search will also try to search in the last
       name column
       • id - optional; type long
       • efakturaIdentifier - optional; type efakturaIdentifierType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
         The efakturaIdentifier of the receiver - a unique identifier for the receiver
       • A choice of one of the following elements:
       • socialSecurityNumber type socialSecurityNumberType - type string with restriction maxLength(11) minLength(11) pattern([0-9]{11})
         The social security number of the receiver.
       • organizationNumber type organizationNumberType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
         Organization number of the sender, issuer or receiver
       • telephoneAlias - optional; type telephoneAliasType - type string with restriction minLength(6) maxLength(16) pattern(\+\d+)
         A valid phone number, prefixed with country code (i.e. +4799999999), used for alias
       • emailAlias - optional; type emailAliasType - type string with restriction minLength(5) maxLength(100) pattern([^@]+@[^\.]+\..+)
         A valid email address, used for alias
       • name - optional; type FullNameType
         The name used to search for receiver to get efaktura identifier.
         Both elements must match those registered on the receiver
         • firstName - optional; type nameType - type string with restriction maxLength(50) minLength(1)
           Name of the receiver, first name or last name
         • lastName type nameType - type string with restriction maxLength(50) minLength(1)
           Name of the receiver, first name or last name
       • address - optional; type AddressType
         The address used to search for receiver to get efaktura identifier.
         All elements must match those registered on the receiver
         • addressLine1 - optional; type addressLineType - type string with restriction maxLength(50)
           Street, postal or other address
         • addressLine2 - optional; type addressLineType - type string with restriction maxLength(50)
           Street, postal or other address
         • postalCode - optional; type postalCodeType - type string with restriction maxLength(10) minLength(4)
         • city - optional; type cityType - type string with restriction maxLength(30) minLength(1)
         • countryCode - optional; type countryCodeType - type string with restriction maxLength(2) minLength(2)
           Country code according to ISO-3166
       • invoiceIssuer - optional; type organizationNumberType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
         Organization number of the sender, issuer or receiver
       • dateOfBirth - optional; type date
       • eFakturaReferenceAndContentProvider - optional; type eFakturaReferenceAndContentProviderType
         • eFakturaReference type eFakturaReferenceType - type string with restriction maxLength(32)
           The customer agreement reference (eFakturareferanse) of the receiver,
           used in the agreement between invoice issuer and receiver (JTTB)
         • contentProviderId type providerIdType - type string with restriction minLength(9) maxLength(9) pattern([0-9]{9})
           Id of the issuer
   • returnOnlyMatchingKeyParams - optional; type boolean
   Output:
   getEfakturaIdentifiersResponse (soap:body, use = literal)Source code
   getEfakturaIdentifiersResponse type GetEfakturaIdentifiersResponse

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   • getEfakturaIdentifiersResponse type EfakturaIdentifiersResponseType
     List with efaktura identifier keys and efaktura identifier if found
     • efakturaIdentifierResponse type EfakturaIdentifierResponseType
       Result of efaktura identifier lookup. The lookup-key is also returned
       to pair the efaktura identifier with the correct receiver.
       • responseResult type efakturaIdentifierResultType - type string with restriction - enum { 'UNIQUE_RECEIVER_FOUND', 'RECEIVER_NOT_FOUND', 'LOOKUP_KEY_MISSING_DATA', 'MULTIPLE_RECEIVERS' }
       • hasAutoAcceptAgreements - optional; type boolean
       • efakturaIdentifier - optional; type efakturaIdentifierType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
         The efakturaIdentifier of the receiver - a unique identifier for the receiver
       • efakturaIdentifierKey type EfakturaIdentifierKeyType
         Contains the keys used to search for a unique receiver to get the efaktura identifier.
         The following rules apply:
         1. Search can be made on social security number, organization number, efaktura identifier or eFakturaReferenceAndContentProvider as single key.
         2. If email alias or phone alias or date of birth is provided at least two of them must match
         3. If only one of date of birth, email alias or phone alias is provided, one of either name, address or
         postal code must match.
         4. If none of date of birth, email alias or phone alias is given all of name, address and postal code must match.
         5. For name and address it is allowed for search where the text is a part of the given field
         6. First and last name is also to be switched, meaning a first name search will also try to search in the last
         name column
         • id - optional; type long
         • efakturaIdentifier - optional; type efakturaIdentifierType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
           The efakturaIdentifier of the receiver - a unique identifier for the receiver
         • A choice of one of the following elements:
         • socialSecurityNumber type socialSecurityNumberType - type string with restriction maxLength(11) minLength(11) pattern([0-9]{11})
           The social security number of the receiver.
         • organizationNumber type organizationNumberType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
           Organization number of the sender, issuer or receiver
         • telephoneAlias - optional; type telephoneAliasType - type string with restriction minLength(6) maxLength(16) pattern(\+\d+)
           A valid phone number, prefixed with country code (i.e. +4799999999), used for alias
         • emailAlias - optional; type emailAliasType - type string with restriction minLength(5) maxLength(100) pattern([^@]+@[^\.]+\..+)
           A valid email address, used for alias
         • name - optional; type FullNameType
           The name used to search for receiver to get efaktura identifier.
           Both elements must match those registered on the receiver
           • firstName - optional; type nameType - type string with restriction maxLength(50) minLength(1)
             Name of the receiver, first name or last name
           • lastName type nameType - type string with restriction maxLength(50) minLength(1)
             Name of the receiver, first name or last name
         • address - optional; type AddressType
           The address used to search for receiver to get efaktura identifier.
           All elements must match those registered on the receiver
           • addressLine1 - optional; type addressLineType - type string with restriction maxLength(50)
             Street, postal or other address
           • addressLine2 - optional; type addressLineType - type string with restriction maxLength(50)
             Street, postal or other address
           • postalCode - optional; type postalCodeType - type string with restriction maxLength(10) minLength(4)
           • city - optional; type cityType - type string with restriction maxLength(30) minLength(1)
           • countryCode - optional; type countryCodeType - type string with restriction maxLength(2) minLength(2)
             Country code according to ISO-3166
         • invoiceIssuer - optional; type organizationNumberType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
           Organization number of the sender, issuer or receiver
         • dateOfBirth - optional; type date
         • eFakturaReferenceAndContentProvider - optional; type eFakturaReferenceAndContentProviderType
           • eFakturaReference type eFakturaReferenceType - type string with restriction maxLength(32)
             The customer agreement reference (eFakturareferanse) of the receiver,
             used in the agreement between invoice issuer and receiver (JTTB)
           • contentProviderId type providerIdType - type string with restriction minLength(9) maxLength(9) pattern([0-9]{9})
             Id of the issuer
       • issuerResponse - optional; type InvoiceIssuerResponseType
         The result of issuer lookup in the getEfakturaIdentifier call. It returns if
         issuer is blocked by receiver, issuer has efaktura agreement with receiver,
         and if found a valid efaktura-referanse is returned
         • blockedByReceiver type boolean
         • hasEfakturaAgreement type boolean
         • efakturaReferences - optional, unbounded; type eFakturaReferenceType - type string with restriction maxLength(32)
           The customer agreement reference (eFakturareferanse) of the receiver,
           used in the agreement between invoice issuer and receiver (JTTB)
   Fault:
   validationFault (soap:fault, use = literal)Source code
   validationFault type ValidationFault

   Indicates that the client has sent an invalid request.

   • errorCode type errorCodeType - type int with restriction minInclusive(200) maxExclusive(299)
   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   Fault:
   serverFault (soap:fault, use = literal)Source code
   serverFault type ServerFault

   Indicates an internal server error.

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
9. getInvoiceStatus
   Source code
   Description:
   Gets an already created invoice
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://efaktura-services.nets.no/efaktura-submitter-service/v1/getInvoiceStatus
   Input:
   getInvoiceStatus (soap:body, use = literal)Source code
   getInvoiceStatus type GetInvoiceStatus

   • auditInformation type AuditInformationType
     Information used for auditing and logging
     • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
       A unique identifier for a request/response message pair used for logging
   • getInvoiceStatuses type GetInvoiceStatusesType
     • getInvoiceStatus type GetInvoiceStatusType
       • consignmentId type consignmentIdType - type string with restriction maxLength(11) minLength(9) pattern([0-9]{9,11})
         Unique 11 digit consignment reference (classic b2c)
       • invoiceId type invoiceReferenceType - type string with restriction maxLength(100) minLength(1) pattern([.-_a-zA-Z0-9\-:{}]+)
         Unique character invoice reference
     List of invoices, to get status for
   Output:
   getInvoiceStatusResponse (soap:body, use = literal)Source code
   getInvoiceStatusResponse type GetInvoiceStatusResponse

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   • invoiceStatusResponses type InvoiceStatusResponsesType
     • invoiceStatusResponse type InvoiceStatusResponseType
       • contentProviderId - optional; type providerIdType - type string with restriction minLength(9) maxLength(9) pattern([0-9]{9})
         Id of the issuer
       • consignmentId type consignmentIdType - type string with restriction maxLength(11) minLength(9) pattern([0-9]{9,11})
         Unique 11 digit consignment reference (classic b2c)
       • invoiceId type invoiceReferenceType - type string with restriction maxLength(100) minLength(1) pattern([.-_a-zA-Z0-9\-:{}]+)
         Unique character invoice reference
       • status type invoiceStatusType - type string with restriction - enum { 'ACCEPTED', 'REJECTED', 'NOT_FOUND', 'CANCELLED' }
       • rejectReason - optional; type rejectReasonType - type string with restriction maxLength(40)
         The reason the invoice was rejected. Only filled out for rejected invoices
       • rejectReasonCode - optional; type rejectReasonCodeType - type string with restriction maxLength(3)
         The status code for the rejected invoice. Only filled out for rejected invoices
       • rejectedAttribute - optional; type rejectedAttributeType - type string with restriction maxLength(50)
         The named attribute causing the invoice rejection. Only filled out for rejected invoices
       • rejectedAttributeValue - optional; type rejectedAttributeValueType - type string with restriction maxLength(250)
         The named attributes value causing the invoice rejection. Only filled out for rejected invoices
     List of invoices, with status
   Fault:
   validationFault (soap:fault, use = literal)Source code
   validationFault type ValidationFault

   Indicates that the client has sent an invalid request.

   • errorCode type errorCodeType - type int with restriction minInclusive(200) maxExclusive(299)
   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   Fault:
   serverFault (soap:fault, use = literal)Source code
   serverFault type ServerFault

   Indicates an internal server error.

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
10. getJwk
    Source code
    Description:
    Get JSON Web Key. Used for validating token in the signed commercial invoice URL.
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    https://efaktura-services.nets.no/efaktura-submitter-service/v1/getJwk
    Input:
    getJwk (soap:body, use = literal)Source code
    getJwk type GetJwk

    Get a list of JSON Web Keys used to verify the jwt signature.

    • auditInformation type AuditInformationType
      Information used for auditing and logging
      • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
        A unique identifier for a request/response message pair used for logging
    Output:
    getJwkResponse (soap:body, use = literal)Source code
    getJwkResponse type GetJwkResponse

    • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
      A unique identifier for a request/response message pair used for logging
    • jwtResponses type JwkResponsesType
      List of Json Web Keys
      • jwkResponseType - optional; type JwkResponseType
        RSA public key in X.509 format.
        • alg type string
          The specific cryptographic algorithm used with the key.
        • kid type string
          The unique identifier for the key.
        • use type string
          How the key was meant to be used. Where sig represents signature usage.
        • n type string
          Modulus, the RSA key length.
        • e type string
          The public key exponent.
        • kty type string
          The family of cryptographic algorithms used with the key.
    Fault:
    validationFault (soap:fault, use = literal)Source code
    validationFault type ValidationFault

    Indicates that the client has sent an invalid request.

    • errorCode type errorCodeType - type int with restriction minInclusive(200) maxExclusive(299)
    • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
      A unique identifier for a request/response message pair used for logging
    Fault:
    serverFault (soap:fault, use = literal)Source code
    serverFault type ServerFault

    Indicates an internal server error.

    • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
      A unique identifier for a request/response message pair used for logging
11. validateSecuritySignature
    Source code
    Description:
    Validates the given security signature and returns the decrypted value.
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    https://efaktura-services.nets.no/efaktura-submitter-service/v1/validateSecuritySignature
    Input:
    validateSecuritySignature (soap:body, use = literal)Source code
    validateSecuritySignature type ValidateSecuritySignature

    Possible validation error codes from operation:
    207 - The signature has timed out (is too old).
    208 - The signature is not valid or manipulated.

    • auditInformation type AuditInformationType
      Information used for auditing and logging
      • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
        A unique identifier for a request/response message pair used for logging
    • encryptedSignature type encryptedSignatureType - type string with restriction pattern(%3CMSG.*%3E)
      An encrypted signature
    Output:
    validateSecuritySignatureResponse (soap:body, use = literal)Source code
    validateSecuritySignatureResponse type ValidateSecuritySignatureResponse

    • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
      A unique identifier for a request/response message pair used for logging
    • decryptedSignature type decryptedSignatureType - type string with restriction
      A decrypted signature
    Fault:
    validationFault (soap:fault, use = literal)Source code
    validationFault type ValidationFault

    Indicates that the client has sent an invalid request.

    • errorCode type errorCodeType - type int with restriction minInclusive(200) maxExclusive(299)
    • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
      A unique identifier for a request/response message pair used for logging
    Fault:
    serverFault (soap:fault, use = literal)Source code
    serverFault type ServerFault

    Indicates an internal server error.

    • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
      A unique identifier for a request/response message pair used for logging
12. validateSecurityToken
    Source code
    Description:
    Validates the given security signature and returns the decrypted value.
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    https://efaktura-services.nets.no/efaktura-submitter-service/v1/validateSecurityToken
    Input:
    validateSecurityToken (soap:body, use = literal)Source code
    validateSecurityToken type ValidateSecurityToken

    Possible validation error codes from operation:
    212 - Different algorithm used for encryption.
    213 - Issuer/Content using to verify is not matching.
    214 - The token is expired.
    215 - The token is Invalid.

    • auditInformation type AuditInformationType
      Information used for auditing and logging
      • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
        A unique identifier for a request/response message pair used for logging
    • invoiceUrl type invoiceUrlType - type string with restriction maxLength(255) minLength(1)
      URL to where the invoice is located
    • encryptedToken type encryptedTokenType - type string with restriction
      An encrypted token
    Output:
    validateSecurityTokenResponse (soap:body, use = literal)Source code
    validateSecurityTokenResponse type ValidateSecurityTokenResponse

    • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
      A unique identifier for a request/response message pair used for logging
    • invoiceUrl type invoiceUrlType - type string with restriction maxLength(255) minLength(1)
      URL to where the invoice is located
    Fault:
    validationFault (soap:fault, use = literal)Source code
    validationFault type ValidationFault

    Indicates that the client has sent an invalid request.

    • errorCode type errorCodeType - type int with restriction minInclusive(200) maxExclusive(299)
    • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
      A unique identifier for a request/response message pair used for logging
    Fault:
    serverFault (soap:fault, use = literal)Source code
    serverFault type ServerFault

    Indicates an internal server error.

    • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
      A unique identifier for a request/response message pair used for logging