Invoice

Service for handling the invoice.

GetInvoice

Get invoice details

Examples

Sample usage in C# with generated client: 
InvoiceClient client = new InvoiceClient();

GetInvoiceResult Result = new GetInvoiceResult();
client.GetInvoice(new SessionHeader(),
new InvoiceLookup
{
CreditorRef = "1000",
InvoiceIdentification = InvoiceIdentificationType.InvoiceNumber,
InvoiceIdentificationValue = "123"
},
out Result
);
Sample soap request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:GetInvoice>
            <urn:InvoiceLookup>
                <urn:CreditorRef>1000</urn:CreditorRef>
                <urn:InvoiceIdentification>InvoiceNumber</urn:InvoiceIdentification>
                <urn:InvoiceIdentificationValue>33077</urn:InvoiceIdentificationValue>
                <!--Optional:-->
            </urn:InvoiceLookup>
        </urn:GetInvoice>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetInvoiceRequest

    GetInvoice request

    • InvoiceLookup

      Information to lookup invoice. In case if CreditorRef is specified search is carried out among the invoices belonging to the creditor otherwise search is carried out among the all invoices. In both cases, the search is carried out taking into account the user creditor access rights.
      Object

      InvoiceLookup

      A lookup for invoice.

      • CreditorRef

        Creditor reference.

        string

      • InvoiceIdentification Mandatory

        Type of invoice identification to look up.
        Enum

        InvoiceIdentificationType

        Invoice identification type.

        • InvoiceGuid

          Invoice identifier (GUID).

        • InvoiceNumber

          Invoice number.

        • LetterReference

          Letter reference.

      • InvoiceIdentificationValue Mandatory

        Invoice identification to look up, depending on type it has different formats.

        string

Output

Invoice details.
Error codes:
  • 1: Generic error message from ARC server.
  • 2: Multiple matching Invoices found.
  • 3: Nothing found.
  • 4: Unknown search invoice type.
Object

GetInvoiceResponse

GetInvoice response

  • GetInvoiceResult

    Result of GetInvoice
    Object

    GetInvoiceResult

    General class for representing method output.

    • Invoice Mandatory

      Invoice details.
      Object

      InvoiceDetails

      Customer invoice details.

      • ActionGroupingCode

        Action grouping code.

        string

      • ActionGroupingGuid

        Action grouping's globally unique identifier.

        string

      • ConvertedToAccountNumber

        If set it has been converted to an account with specified account number.

        string

      • CurrencyCode

        Currency code, e.g. SEK, NOK, EUR etc.

        string

      • DueDate

        Due date of invoice.

        DateTime

      • ExtraFields

        List of extra fields for custom data.
        Array
        Object

        ExtraField

        Extra field contains custom data.

        • Data

          Value of extra field.

          string

        • Name

          Name of extra field.

          string

      • FirstLetterHistoryGuid

        First letter history item globally unique identifier.

        string

      • InvoiceAmount

        Invoiced amount.

        decimal

      • InvoiceDate

        Invoice date.

        DateTime

      • InvoiceNumber

        Invoice number.

        string

      • InvoiceStatus

        Status of the invoice.
        Enum

        InvoiceStatus

        Invoice status.

        • Unknown

          Invoice status unknown.

        • Paid

          Invoice has been paid.

        • Unpaid

          Invoice is not paid.

        • Overdue

          Invoice is overdue.

        • OverPayment

          More than requested amount has been paid on invoice.

        • Reminder

          Reminder sent for invoice.

        • Collection

          Invoice sent to debt collection.

        • Credited

          Invoice has been credited.

        • ConvertedToAccount

          Invoice has been converted to account.

      • LatestLetterHistoryGuid

        Latest letter history item globally unique identifier.

        string

      • LetterDueDate

        Letter sent has due date.

        DateTime

      • LetterPaymentAmount

        The amount to pay on letter.

        decimal

      • OriginalCreditorReference

        Original creditor reference.

        string

      • PaymentBankAccountNumber

        Bank account number where payment should go, e.g. Bankgiro.

        string

      • PaymentReferenceNumber

        Payment reference number, e.g. OCR.

        string

      • RemainingAmount

        Amount remaining to be paid.

        decimal

      • UniqueID

        Invoice unique id.

        string

    • Result Mandatory

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string