Web Service: EfakturaAtgService

Port type EfakturaAtgPortTypeSource code

1. addShipment
   Source code
   Description:
   Creates a shipment with transactions (eFaktura, AvtaleGiro or a combination). Possible validation error codes from operation: 3002 - Shipment id already exists 3003 - Transaction id already exists 3010 - ATG info is missing for an ATG transaction 3011 - eFaktua info is missing for an eFaktura transaction 3020 - KID is missing for an ATG transaction 3021 - ATG transaction is not document type INVOICE 3100 - Document type not implemented (currently only INVOICE is allowed) 3101 - AvtaleGiro transactions are not allowed
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://efaktura-services.nets.no/efaktura-atg-service/v1/addShipment
   Input:
   addShipment (soap:body, use = literal)Source code
   addShipment type AddShipmentRequest

   Add a new shipment with transactions.
   Use getShipmentStatus or getTransactionStatus to check the status.

   • auditInformation type AuditInformationType
     Information used for auditing and logging messages. The service replies with
     the same messageIdentifier sent in.
     • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
       A unique identifier for a request/response message pair used for logging
   • shipmentId type uuidType - type string with restriction maxLength(36) minLength(36) pattern([a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12})
     A unique reference - UUID
   • issuer type organizationNumberType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
   • transactions type TransactionsType
     Allows up to a 1000 transactions per shipment.
     • transactions type TransactionType
       • transactionId type uuidType - type string with restriction maxLength(36) minLength(36) pattern([a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12})
         A unique reference - UUID
       • paymentType type paymentType - type string with restriction - enum { 'EFAKTURA', 'EFAKTURA_AND_AVTALEGIRO', 'EFAKTURA_AND_EXTERNAL_AVTALEGIRO', 'AVTALEGIRO' }
       • documentType type documentType - type string with restriction - enum { 'INVOICE', 'CREDIT_NOTE', 'REMINDER', 'COLLECTION_NOTICE', 'DUNNING', 'PAYMENT_REQUEST', 'ENFORCEMENT_WARNING' }
       • kid - optional; type kidType - type string with restriction maxLength(25) minLength(2) pattern(\d*)
         Mandatory for ATGs, but not for eFaktruas
       • accountNumber type accountNumberType - type string with restriction length(11)
         The account number that the issuer will be credited.
         Must be a Norwegian account number with 11 digits
       • amount type simpleAmountType - type decimal with restriction fractionDigits(2) minInclusive(0.00)
         The amount represented as a positive number with two decimals.
       • dueDate type date
       • efakturaInfo - optional; type EfakturaType
         Must be added for eFakturas
         • 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.
         • socialSecurityNumber type socialSecurityNumberType - type string with restriction maxLength(11) minLength(11) pattern([0-9]{11})
         • eFakturaReference type efakturaReferenceType - type string with restriction maxLength(32) minLength(1)
           The eFaktura reference of the receiver
         • minimumAmount - optional; type simpleAmountType - type decimal with restriction fractionDigits(2) minInclusive(0.00)
           The amount represented as a positive number with two decimals.
         • brandName type brandNameType - type string with restriction maxLength(40)
           Name that is shown to the receiver of the eFaktura
         • eFakturaUrl type eFakturaUrlType - type string with restriction maxLength(255) minLength(1)
           URL to where the eFaktura invoice is located
         • collectionNoticeNotification - optional; type CollectionNoticeNotification
           Forced notifications for collection notices. Only valid for collection notice.
           • email - optional; type emailType - type string with restriction minLength(5) maxLength(100) pattern([^@]+@[^\.]+\..+)
             A valid email address - used for alias.
           • mobilePhone - optional; type telephoneType - type string with restriction minLength(6) maxLength(16) pattern(\+\d+)
             A valid phone number - used for alias.
             Prefixed with country code (i.e. +4799999999).
       • atgInfo - optional; type AtgType
         Must be added for ATGs
         • atgNotification type boolean
         • atgNotificationText - optional; type atgNotificationTextType - type string with restriction maxLength(3360) minLength(0)
           Notification text for AvtaleGiro.
           Max length 3360, but should be divided in 80 character lines and maximum 42 lines.
         • atgAbbreviatedName - optional; type atgAbbreviatedNameType - type string with restriction maxLength(10) minLength(1)
           The field may be used to inform payer about the AvtaleGiro payment.
           The external reference will be transferred to payer’s statement and AvtaleGiro info.
           The external reference will override the set text on payer’s regular payment assignment.
         • atgExternalReference - optional; type atgExternalReferenceType - type string with restriction maxLength(25) minLength(1)
           The abbreviated name for the AvtaleGiro payer.
           The field should be filled in to make identification of any denied due payments easier.
   Output:
   addShipmentResponse (soap:body, use = literal)Source code
   addShipmentResponse type AddShipmentResponse

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   • noOfTransactions type transactionsCountType - type int with restriction
   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(3000) maxExclusive(3999)
   • 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. cancelShipment
   Source code
   Description:
   Cancel a shipment. Possible validation error codes from operation: 3000 - Shipment not found
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://efaktura-services.nets.no/efaktura-atg-service/v1/cancelShipment
   Input:
   cancelShipment (soap:body, use = literal)Source code
   cancelShipment type CancelShipmentRequest

   Cancel all transactions in shipment.

   • auditInformation type AuditInformationType
     Information used for auditing and logging messages. The service replies with
     the same messageIdentifier sent in.
     • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
       A unique identifier for a request/response message pair used for logging
   • shipmentId type uuidType - type string with restriction maxLength(36) minLength(36) pattern([a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12})
     A unique reference - UUID
   Output:
   cancelShipmentResponse (soap:body, use = literal)Source code
   cancelShipmentResponse type CancelShipmentResponse

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   • shipmentId type uuidType - type string with restriction maxLength(36) minLength(36) pattern([a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12})
     A unique reference - UUID
   • efakturaStatus type efakturaShipmentCancellationStatusType - type string with restriction - enum { 'NO_EFAKTURA_IN_SHIPMENT', 'CANCELLATION_REQUESTED', 'ALREADY_CANCELLED', 'NOT_FOUND', 'PROCESSING_IN_PROGRESS-TRY_LATER' }
   • atgStatus type atgShipmentCancellationStatusType - type string with restriction - enum { 'NO_ATG_IN_SHIPMENT', 'CANCELLATION_REQUESTED', 'NOT_ALLOWED', 'NOT_FOUND', 'PROCESSING_IN_PROGRESS-TRY_LATER' }
   • atgCancellationMessage - optional; type string
   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(3000) maxExclusive(3999)
   • 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. cancelTransaction
   Source code
   Description:
   Cancel a transaction. Possible validation error codes from operation: 3001 - Transaction not found
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://efaktura-services.nets.no/efaktura-atg-service/v1/cancelTransactions
   Input:
   cancelTransaction (soap:body, use = literal)Source code
   cancelTransaction type CancelTransactionRequest

   • auditInformation type AuditInformationType
     Information used for auditing and logging messages. The service replies with
     the same messageIdentifier sent in.
     • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
       A unique identifier for a request/response message pair used for logging
   • transactionId type uuidType - type string with restriction maxLength(36) minLength(36) pattern([a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12})
     A unique reference - UUID
   Output:
   cancelTransactionResponse (soap:body, use = literal)Source code
   cancelTransactionResponse type CancelTransactionResponse

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   • transactionId type uuidType - type string with restriction maxLength(36) minLength(36) pattern([a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12})
     A unique reference - UUID
   • efakturaStatus type efakturaTransactionCancellationStatusType - type string with restriction - enum { 'NOT_AN_EFAKTURA_TRANSACTION', 'CANCELLATION_REQUESTED', 'ALREADY_CANCELLED', 'NOT_FOUND', 'PROCESSING_IN_PROGRESS-TRY_LATER' }
   • atgStatus type atgTransactionCancellationStatusType - type string with restriction - enum { 'NOT_AN_ATG_TRANSACTION', 'CANCELLATION_REQUESTED', 'NOT_ALLOWED', 'NOT_FOUND', 'PROCESSING_IN_PROGRESS-TRY_LATER' }
   • atgCancellationMessage - optional; type string
   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(3000) maxExclusive(3999)
   • 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. getAtgMandate
   Source code
   Description:
   Check if a mandate exists Possible validation error codes from operation: 3102 - Get mandate is currently disabled
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://efaktura-services.nets.no/efaktura-atg-service/v1/getAtgMandate
   Input:
   getAtgMandateRequest (soap:body, use = literal)Source code
   getAtgMandateRequest type GetAtgMandateRequest

   Check if a mandate exists.

   • auditInformation type AuditInformationType
     Information used for auditing and logging messages. The service replies with
     the same messageIdentifier sent in.
     • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
       A unique identifier for a request/response message pair used for logging
   • kid type kidType - type string with restriction maxLength(25) minLength(2) pattern(\d*)
   • creditAccount type accountNumberType - type string with restriction length(11)
     The account number that the issuer will be credited.
     Must be a Norwegian account number with 11 digits
   Output:
   getAtgMandateResponse (soap:body, use = literal)Source code
   getAtgMandateResponse type GetAtgMandateResponse

   Return the mandate if exists, else mandate will be null.

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   • mandate - optional; type MandateInfoType
     • kid type kidType - type string with restriction maxLength(25) minLength(2) pattern(\d*)
     • creditAccount type accountNumberType - type string with restriction length(11)
       The account number that the issuer will be credited.
       Must be a Norwegian account number with 11 digits
     • notification type boolean
   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(3000) maxExclusive(3999)
   • 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. getBlackList
   Source code
   Description:
   Get black listed eFaktura issuers
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://efaktura-services.nets.no/efaktura-atg-service/v1/getBlackList
   Input:
   getBlackList (soap:body, use = literal)Source code
   getBlackList type GetBlackListRequest

   • auditInformation type AuditInformationType
     Information used for auditing and logging messages. The service replies with
     the same messageIdentifier sent in.
     • 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
   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(3000) maxExclusive(3999)
   • 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. 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-atg-service/v1/getEfakturaIdentifiers
   Input:
   getEfakturaIdentifiers (soap:body, use = literal)Source code
   getEfakturaIdentifiers type GetEfakturaIdentifiersRequest

   • auditInformation type AuditInformationType
     Information used for auditing and logging messages. The service replies with
     the same messageIdentifier sent in.
     • 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
     • 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.
       • 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})
       • organizationNumber type organizationNumberType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
       • telephoneAlias - optional; type telephoneType - type string with restriction minLength(6) maxLength(16) pattern(\+\d+)
         A valid phone number - used for alias.
         Prefixed with country code (i.e. +4799999999).
       • emailAlias - optional; type emailType - 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)
         • lastName type nameType - type string with restriction maxLength(50) minLength(1)
       • 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)
         • addressLine2 - optional; type addressLineType - type string with restriction maxLength(50)
         • postalCode - optional; type postalCodeType - type string with restriction maxLength(10) minLength(4)
         • city - optional; type postalCityType - type string with restriction maxLength(30) minLength(1)
         • countryCode - optional; type countryCodeType - type string with restriction maxLength(2) minLength(2)
       • efakturaIssuer - optional; type organizationNumberType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
       • 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 eFaktura issuer and receiver.
         • contentProviderId type providerIdType - type string with restriction minLength(9) maxLength(9) pattern([0-9]{9})
   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' }
       • autoAcceptEfaktura type boolean
         If all eFaktura agreements should be accepted
         automatically for this eFaktura 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.
       • 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.
         • 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})
         • organizationNumber type organizationNumberType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
         • telephoneAlias - optional; type telephoneType - type string with restriction minLength(6) maxLength(16) pattern(\+\d+)
           A valid phone number - used for alias.
           Prefixed with country code (i.e. +4799999999).
         • emailAlias - optional; type emailType - 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)
           • lastName type nameType - type string with restriction maxLength(50) minLength(1)
         • 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)
           • addressLine2 - optional; type addressLineType - type string with restriction maxLength(50)
           • postalCode - optional; type postalCodeType - type string with restriction maxLength(10) minLength(4)
           • city - optional; type postalCityType - type string with restriction maxLength(30) minLength(1)
           • countryCode - optional; type countryCodeType - type string with restriction maxLength(2) minLength(2)
         • efakturaIssuer - optional; type organizationNumberType - type string with restriction maxLength(9) minLength(9) pattern([0-9]{9})
         • 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 eFaktura issuer and receiver.
           • contentProviderId type providerIdType - type string with restriction minLength(9) maxLength(9) pattern([0-9]{9})
       • issuerResponse - optional; type EfakturaIssuerResponseType
         The result of issuer lookup in the getEfakturaIdentifier call. It returns if
         issuer is blocked by receiver, if issuer has eFaktura agreement with receiver,
         and if found a valid eFaktura reference 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 eFaktura issuer and receiver.
   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(3000) maxExclusive(3999)
   • 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. getShipments
   Source code
   Description:
   Returns all shipment IDs sent in by the user within a time interval. Possible validation error codes from operation: 3040 - interval too long
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://efaktura-services.nets.no/efaktura-atg-service/v1/getShipments
   Input:
   getShipments (soap:body, use = literal)Source code
   getShipments type GetShipmentsRequest

   • auditInformation type AuditInformationType
     Information used for auditing and logging messages. The service replies with
     the same messageIdentifier sent in.
     • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
       A unique identifier for a request/response message pair used for logging
   • from type dateTime
   • to type dateTime
   Output:
   getShipmentsResponse (soap:body, use = literal)Source code
   getShipmentsResponse type GetShipmentsResponse

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   • numberOfShipmentsFound type int
   • shipmentsResponses type ShipmentsResponsesType
     • shipmentsResponseType - optional, unbounded; type ShipmentsResponseType
       • id type uuidType - type string with restriction maxLength(36) minLength(36) pattern([a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12})
         A unique reference - UUID
   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(3000) maxExclusive(3999)
   • 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. getShipmentStatus
   Source code
   Description:
   Get the status of a shipment. Possible validation error codes from operation: 3000 - Shipment not found
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://efaktura-services.nets.no/efaktura-atg-service/v1/getShipmentStatus
   Input:
   getShipmentStatus (soap:body, use = literal)Source code
   getShipmentStatus type GetShipmentStatusRequest

   • auditInformation type AuditInformationType
     Information used for auditing and logging messages. The service replies with
     the same messageIdentifier sent in.
     • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
       A unique identifier for a request/response message pair used for logging
   • shipmentId type uuidType - type string with restriction maxLength(36) minLength(36) pattern([a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12})
     A unique reference - UUID
   Output:
   getShipmentStatusResponse (soap:body, use = literal)Source code
   getShipmentStatusResponse type GetShipmentStatusResponse

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   • shipmentId type uuidType - type string with restriction maxLength(36) minLength(36) pattern([a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12})
     A unique reference - UUID
   • efakturaShipmentStatus type shipmentEfakturaStatusType - type string with restriction - enum { 'IN_PROGRESS', 'PROCESSED', 'STOPPED', 'NO_EFAKTURA_IN_SHIPMENT' }
   • atgShipmentStatus type shipmentAtgStatusType - type string with restriction - enum { 'NO_ATG_IN_SHIPMENT', 'IN_PROGRESS', 'RECEIVED', 'REJECTED', 'PROCESSING', 'PROCESSED', 'PROCESSED_WITH_WARNING', 'SENT_TO_BDS', 'CANCELLATION_RECEIVED', 'CANCELLATION_VALIDATED', 'CANCELLATION_PROCESSED', 'CANCELLATION_PROCESSING', 'CANCELLATION_REJECTED', 'CANCELLATION_SENT_TO_BDS', 'CANCELLATION_REJECTED_BY_BDS', 'CANCELLATION_ACCEPTED_BY_BDS' }
   • transactionCount type int
   • efakturaTransactionCount type int
   • atgTransactionCount type int
   • transactionsStatuses - optional; type TransactionStatusesType
     • transactionStatus type TransactionStatusType
       • transactionId type uuidType - type string with restriction maxLength(36) minLength(36) pattern([a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12})
         A unique reference - UUID
       • efakturaTransactionStatus - optional; type EfakturaTransactionStatusType
         • status type efakturaStatusType - type string with restriction - enum { 'NOT_AN_EFAKTURA_TRANSACTION', 'IN_PROGRESS', 'CANCELLED', 'REJECTED', 'STOPPED', 'ACCEPTED' }
         • rejectionCode - optional; type rejectionCodeType - type string with restriction maxLength(4) minLength(1)
           The reason why something was rejected, as a code
         • rejectionText - optional; type rejectionTextType - type string with restriction maxLength(2000) minLength(1)
           The reason why something was rejected
       • atgTransactionStatus - optional; type AtgTransactionStatusType
         • status type atgStatusType - type string with restriction - enum { 'NOT_AN_ATG_TRANSACTION', 'EXTERNAL_ATG', 'IN_PROGRESS', 'RECEIVED', 'REJECTED', 'PROCESSING', 'PROCESSED', 'PROCESSED_WITH_WARNING', 'SENT_TO_BDS', 'CANCELLATION_RECEIVED', 'CANCELLATION_VALIDATED', 'CANCELLATION_PROCESSED', 'CANCELLATION_PROCESSING', 'CANCELLATION_REJECTED', 'CANCELLATION_SENT_TO_BDS', 'CANCELLATION_REJECTED_BY_BDS', 'CANCELLATION_ACCEPTED_BY_BDS' }
         • code - optional; type rejectionCodeType - type string with restriction maxLength(4) minLength(1)
           The reason why something was rejected, as a code
         • text - optional; type rejectionTextType - type string with restriction maxLength(2000) minLength(1)
           The reason why something 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(3000) maxExclusive(3999)
   • 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. getTransactionStatus
   Source code
   Description:
   Get the status of a transaction. Possible validation error codes from operation: 3001 - Transaction not found
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://efaktura-services.nets.no/efaktura-atg-service/v1/getTransactionStatus
   Input:
   getTransactionStatus (soap:body, use = literal)Source code
   getTransactionStatus type GetTransactionStatusRequest

   • auditInformation type AuditInformationType
     Information used for auditing and logging messages. The service replies with
     the same messageIdentifier sent in.
     • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
       A unique identifier for a request/response message pair used for logging
   • transactionId type uuidType - type string with restriction maxLength(36) minLength(36) pattern([a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12})
     A unique reference - UUID
   Output:
   getTransactionStatusResponse (soap:body, use = literal)Source code
   getTransactionStatusResponse type GetTransactionStatusResponse

   • messageIdentifier type messageIdentifierType - type string with restriction minLength(5) maxLength(50)
     A unique identifier for a request/response message pair used for logging
   • transactionStatus type TransactionStatusType
     • transactionId type uuidType - type string with restriction maxLength(36) minLength(36) pattern([a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12})
       A unique reference - UUID
     • efakturaTransactionStatus - optional; type EfakturaTransactionStatusType
       • status type efakturaStatusType - type string with restriction - enum { 'NOT_AN_EFAKTURA_TRANSACTION', 'IN_PROGRESS', 'CANCELLED', 'REJECTED', 'STOPPED', 'ACCEPTED' }
       • rejectionCode - optional; type rejectionCodeType - type string with restriction maxLength(4) minLength(1)
         The reason why something was rejected, as a code
       • rejectionText - optional; type rejectionTextType - type string with restriction maxLength(2000) minLength(1)
         The reason why something was rejected
     • atgTransactionStatus - optional; type AtgTransactionStatusType
       • status type atgStatusType - type string with restriction - enum { 'NOT_AN_ATG_TRANSACTION', 'EXTERNAL_ATG', 'IN_PROGRESS', 'RECEIVED', 'REJECTED', 'PROCESSING', 'PROCESSED', 'PROCESSED_WITH_WARNING', 'SENT_TO_BDS', 'CANCELLATION_RECEIVED', 'CANCELLATION_VALIDATED', 'CANCELLATION_PROCESSED', 'CANCELLATION_PROCESSING', 'CANCELLATION_REJECTED', 'CANCELLATION_SENT_TO_BDS', 'CANCELLATION_REJECTED_BY_BDS', 'CANCELLATION_ACCEPTED_BY_BDS' }
       • code - optional; type rejectionCodeType - type string with restriction maxLength(4) minLength(1)
         The reason why something was rejected, as a code
       • text - optional; type rejectionTextType - type string with restriction maxLength(2000) minLength(1)
         The reason why something was rejected
   • transaction type TransactionType
     • transactionId type uuidType - type string with restriction maxLength(36) minLength(36) pattern([a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12})
       A unique reference - UUID
     • paymentType type paymentType - type string with restriction - enum { 'EFAKTURA', 'EFAKTURA_AND_AVTALEGIRO', 'EFAKTURA_AND_EXTERNAL_AVTALEGIRO', 'AVTALEGIRO' }
     • documentType type documentType - type string with restriction - enum { 'INVOICE', 'CREDIT_NOTE', 'REMINDER', 'COLLECTION_NOTICE', 'DUNNING', 'PAYMENT_REQUEST', 'ENFORCEMENT_WARNING' }
     • kid - optional; type kidType - type string with restriction maxLength(25) minLength(2) pattern(\d*)
       Mandatory for ATGs, but not for eFaktruas
     • accountNumber type accountNumberType - type string with restriction length(11)
       The account number that the issuer will be credited.
       Must be a Norwegian account number with 11 digits
     • amount type simpleAmountType - type decimal with restriction fractionDigits(2) minInclusive(0.00)
       The amount represented as a positive number with two decimals.
     • dueDate type date
     • efakturaInfo - optional; type EfakturaType
       Must be added for eFakturas
       • 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.
       • socialSecurityNumber type socialSecurityNumberType - type string with restriction maxLength(11) minLength(11) pattern([0-9]{11})
       • eFakturaReference type efakturaReferenceType - type string with restriction maxLength(32) minLength(1)
         The eFaktura reference of the receiver
       • minimumAmount - optional; type simpleAmountType - type decimal with restriction fractionDigits(2) minInclusive(0.00)
         The amount represented as a positive number with two decimals.
       • brandName type brandNameType - type string with restriction maxLength(40)
         Name that is shown to the receiver of the eFaktura
       • eFakturaUrl type eFakturaUrlType - type string with restriction maxLength(255) minLength(1)
         URL to where the eFaktura invoice is located
       • collectionNoticeNotification - optional; type CollectionNoticeNotification
         Forced notifications for collection notices. Only valid for collection notice.
         • email - optional; type emailType - type string with restriction minLength(5) maxLength(100) pattern([^@]+@[^\.]+\..+)
           A valid email address - used for alias.
         • mobilePhone - optional; type telephoneType - type string with restriction minLength(6) maxLength(16) pattern(\+\d+)
           A valid phone number - used for alias.
           Prefixed with country code (i.e. +4799999999).
     • atgInfo - optional; type AtgType
       Must be added for ATGs
       • atgNotification type boolean
       • atgNotificationText - optional; type atgNotificationTextType - type string with restriction maxLength(3360) minLength(0)
         Notification text for AvtaleGiro.
         Max length 3360, but should be divided in 80 character lines and maximum 42 lines.
       • atgAbbreviatedName - optional; type atgAbbreviatedNameType - type string with restriction maxLength(10) minLength(1)
         The field may be used to inform payer about the AvtaleGiro payment.
         The external reference will be transferred to payer’s statement and AvtaleGiro info.
         The external reference will override the set text on payer’s regular payment assignment.
       • atgExternalReference - optional; type atgExternalReferenceType - type string with restriction maxLength(25) minLength(1)
         The abbreviated name for the AvtaleGiro payer.
         The field should be filled in to make identification of any denied due payments easier.
   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(3000) maxExclusive(3999)
   • 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. validateSecuritySignature
    Source code
    Description:
    Validates the given security signature and returns the decrypted value. Possible validation error codes from operation: 3030 - the signature has timed out 3031 - the signature is manipulated
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    https://efaktura-services.nets.no/efaktura-atg-service/v1/validateSecuritySignature
    Input:
    validateSecuritySignature (soap:body, use = literal)Source code
    validateSecuritySignature type ValidateSecuritySignatureRequest

    • auditInformation type AuditInformationType
      Information used for auditing and logging messages. The service replies with
      the same messageIdentifier sent in.
      • 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)
    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
    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(3000) maxExclusive(3999)
    • 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