Port type EfakturaNetsSubmitterPortTypeSource 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/invoicing-nets-submitter/v1/addInvoices
   Input:
   addInvoices (soap:body, use = literal)Source code
   addInvoices type AddInvoices

   To get status for the invoices and consignments use the getInvoiceStatus and
   getConsignmentStatus call.

   • auditInformation type AuditInformationType
     Information used for auditing and logging messages
     • 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(11) pattern([0-9]{11})
     Unique 11 digit consignment reference
   • invoices type InvoicesType
   • A choice of one of the following elements:
   • invoice type InvoiceType
     • invoiceNumber type InvoiceNumberType - type string with restriction maxLength(100) minLength(1)
       Unique reference to the invoice for the issuer.
     • 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, the unique efaktura address for this 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)
     • issuer type OrganizationNumberType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
     • 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 BillingAccountNumberType - type string with restriction length(11)
       Must be a Norwegian account number with 11 digits
     • documentType type documentType - type string with restriction - enum { 'EFAKTURA', 'AVTALEGIRO' }
     • A choice of one of the following elements:
     • pdf type Pdf - type base64Binary with restriction
       PDF representation of the invoice
     • invoiceSpecification type InvoiceSpecification
       Contains the invoice specification fields
       • receiverName - optional; type FullNameType
         • firstName - optional; type NameType - type string with restriction maxLength(100) minLength(1)
           Name of the issuer
         • lastName type NameType - type string with restriction maxLength(100) minLength(1)
           Name of the issuer
       • receiverAddress - optional; type AddressType
         • 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 type PostalCodeType - type string with restriction maxLength(10) minLength(4)
         • city type PostalCityType - type string with restriction maxLength(30) minLength(1)
         • countryCode - optional; type CountryCodeType - type string with restriction maxLength(2) minLength(2)
       • senderName - optional; type FullNameType
         • firstName - optional; type NameType - type string with restriction maxLength(100) minLength(1)
           Name of the issuer
         • lastName type NameType - type string with restriction maxLength(100) minLength(1)
           Name of the issuer
       • senderAddress - optional; type AddressType
         • 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 type PostalCodeType - type string with restriction maxLength(10) minLength(4)
         • city type PostalCityType - type string with restriction maxLength(30) minLength(1)
         • countryCode - optional; type CountryCodeType - type string with restriction maxLength(2) minLength(2)
       • invoiceDate - optional; type date
       • itemName - optional; type Text100 - type string with restriction maxLength(200)
       • itemDescription - optional; type Text50 - type string with restriction maxLength(100)
       • paymentTerms - optional; type Text100 - type string with restriction maxLength(200)
       • customValues - optional; type CustomValuesType
         Key-value pair for adding custom values. Note that the key's
         must be unique if more than one is added
         • key type Text20 - type string with restriction maxLength(20)
         • value type Text50 - type string with restriction maxLength(100)
   • efhXml type EhfXml - type base64Binary with restriction
     Base64 encoded ehfFile. Must contain a unique number per invoice
   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(5000) maxExclusive(5999)
   • 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. 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/invoicing-nets-submitter/v1/getConsignmentStatus
   Input:
   getConsignmentStatus (soap:body, use = literal)Source code
   getConsignmentStatus type GetConsignmentStatus

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

   • auditInformation type AuditInformationType
     Information used for auditing and logging messages
     • 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(11) pattern([0-9]{11})
     Unique 11 digit consignment reference
   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', 'PROCESSED', 'REJECTED', 'STOPPED' }
   • rejectedReason - optional; type RejectReasonType - type string with restriction maxLength(2000) minLength(1)
     The reason the invoice or consignment was rejected.
   • acceptedInvoiceCount type long
   • rejectedInvoiceCount type long
   • rejectedInvoices - optional; type RejectedInvoicesType
     • rejectedInvoice - optional; type RejectedInvoiceType
       • invoiceNumber type InvoiceNumberType - type string with restriction maxLength(100) minLength(1)
         Unique reference to the invoice for the issuer.
       • rejectedReason type RejectReasonType - type string with restriction maxLength(2000) minLength(1)
         The reason the invoice or consignment was rejected.
     List of 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(5000) maxExclusive(5999)
   • 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. 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/invoicing-nets-submitter/v1/getEfakturaIdentifiers
   Input:
   getEfakturaIdentifiers (soap:body, use = literal)Source code
   getEfakturaIdentifiers type GetEfakturaIdentifiers

   • auditInformation type AuditInformationType
     Information used for auditing and logging messages
     • 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 a unique receiver to get the efaktura identifier
     • efakturaIdentifierKey type EfakturaIdentifierKeyType
       Contains the keys used to search for a unique receiver to get the efaktura identifier.
       Search can be made on social security number, organization number or efaktura identifier as single key.
       If none of these are given, at least 2 other keys must be given.
       All keys given must match the information registered on the receiver.
       • efakturaIdentifier - optional; type EfakturaIdentifierType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
         The efakturaIdentifier of the receiver, the unique efaktura address for this 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. This is encrypted
       • organizationNumber type OrganizationNumberType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
       • 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
         • firstName - optional; type NameType - type string with restriction maxLength(100) minLength(1)
           Name of the issuer
         • lastName type NameType - type string with restriction maxLength(100) minLength(1)
           Name of the issuer
       • address - optional; type AddressType
         • 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 type PostalCodeType - type string with restriction maxLength(10) minLength(4)
         • city type PostalCityType - type string with restriction maxLength(30) minLength(1)
         • countryCode - optional; type CountryCodeType - type string with restriction maxLength(2) minLength(2)
       • invoiceIssuer - optional; type OrganizationNumberType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
       • dateOfBirth - optional; type date
   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 efakturaidentifier-keys and efakturaidentifier if found
     • efakturaIdentifierResponse type EfakturaIdentifierResponseType
       Result of efakturaidentifier 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, the unique efaktura address for this receiver
       • efakturaIdentifierKey type EfakturaIdentifierKeyType
         Contains the keys used to search for a unique receiver to get the efaktura identifier.
         Search can be made on social security number, organization number or efaktura identifier as single key.
         If none of these are given, at least 2 other keys must be given.
         All keys given must match the information registered on the receiver.
         • efakturaIdentifier - optional; type EfakturaIdentifierType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
           The efakturaIdentifier of the receiver, the unique efaktura address for this 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. This is encrypted
         • organizationNumber type OrganizationNumberType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
         • 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
           • firstName - optional; type NameType - type string with restriction maxLength(100) minLength(1)
             Name of the issuer
           • lastName type NameType - type string with restriction maxLength(100) minLength(1)
             Name of the issuer
         • address - optional; type AddressType
           • 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 type PostalCodeType - type string with restriction maxLength(10) minLength(4)
           • city type PostalCityType - type string with restriction maxLength(30) minLength(1)
           • countryCode - optional; type CountryCodeType - type string with restriction maxLength(2) minLength(2)
         • invoiceIssuer - optional; type OrganizationNumberType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
         • dateOfBirth - optional; type date
       • 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(5000) maxExclusive(5999)
   • 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. 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/invoicing-nets-submitter/v1/getInvoiceStatus
   Input:
   getInvoiceStatus (soap:body, use = literal)Source code
   getInvoiceStatus type GetInvoiceStatus

   • auditInformation type AuditInformationType
     Information used for auditing and logging messages
     • 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
     List of invoices, to get status for
     • getInvoiceStatus type GetInvoiceStatusType
       • issuer type OrganizationNumberType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
       • invoiceNumber type InvoiceNumberType - type string with restriction maxLength(100) minLength(1)
         Unique reference to the invoice for the issuer.
   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
     List of invoices, with status
     • invoiceStatusResponse type InvoiceStatusResponseType
       • issuer type OrganizationNumberType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
       • invoiceNumber type InvoiceNumberType - type string with restriction maxLength(100) minLength(1)
         Unique reference to the invoice for the issuer.
       • status type InvoiceStatusType - type string with restriction - enum { 'PROCESSED', 'REJECTED', 'IN_PROGRESS', 'DUPLICATE', 'NOT_FOUND', 'CANCELLED' }
       • rejectReason - optional; type RejectReasonType - type string with restriction maxLength(2000) minLength(1)
         The reason the invoice or consignment was rejected.
   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(5000) maxExclusive(5999)
   • 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