ApproveInvoices


 

Overview

Quick Links

Approves specified invoices if possible.


Resource Information



Request FormatXML
Response FormatXML

Request Header

NameTypeDescription
StringStringAuthentication Token

Request Body

NameTypeDescription
invoiceIds
List of StringA list of invoice ids identifying the invoices to approve.
reason
string
The reason to record in the approval message.

Response

NameTypeDescription
ResultBulkInvoiceApproveResult
The result of the approval call. Lists which invoices were approved and which were not.
ResultCodeStringString indicating the result. Either "Success" or "Error".
ResultMessageStringEmpty when call successful, error message otherwise.

In the case of an internal unhandled fault, a Fault object is returned instead. Providing information on what occurred exactly.

Examples

Note that these examples use V1.3.2 of the API and the token authentication flow.

Request

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Header xmlns:t="http://api.cloudbilling.nl/2018/11/auth/token"><t:ApiToken>TOKEN</t:ApiToken></Header>
    <Body>
        <ApproveInvoices xmlns="api.billing.inter8.V1_3_2">
            <reason>Approval reason</reason>
            <invoiceIds>
                <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">12345</string>
                <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">12346</string>
                <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">12347</string>
            </invoiceIds>
        </ApproveInvoices>
    </Body>
</Envelope>

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <ApproveInvoicesResponse xmlns="api.billing.inter8.V1_3_2">
            <ApproveInvoicesResult xmlns:a="http://schemas.datacontract.org/2004/07/Kolonel.Public.Service.API.Contracts.V1_3_2" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <a:Result>
                    <a:Approved>
                        <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">12345</string>
                        <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">12346</string>
                    </a:Approved>
                    <a:NotApproved>
                        <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">12347</string>
                    </a:NotApproved>
                </a:Result>
                <a:ResultCode>Success</a:ResultCode>
                <a:ResultMessage/>
            </ApproveInvoicesResult>
        </ApproveInvoicesResponse>
    </s:Body>
</s:Envelope>