placeInvoice | CPP Help Center

With the "placeInvoice" call you can upload invoices to Channel Pilot Pro.

Parameters for SOAP call

PlaceInvoiceResult placeInvoice(
    CPAuth auth,
    String externalOrderId,
    String channel,
    byte[] invoiceContent,
    String invoiceNumber,
    String fileName,
    double totalAmount,
    double totalVatAmount,
    boolean overwrite,
    String invoiceType
);

Parameter descriptions

All parameters from the list below must be set.

Parameter	Type	Optional	Comment
auth	CPAuth	no	Authentication data
externalOrderId	String	no	Order Id, which was given from the specific marketplace
channel	String	no	Unique channel description (e.g. “amazon.de)
invoiceContent	Byte[]	no	Content of the invoice, which has to be uploaded (as byte array)
invoiceNumber	String	no	The invoice number used in the invoice
fileName	String	no	The name of the given invoice
totalAmount	Number	no	The total amount of the invoice
totalVatAmount	Number	no	The total VAT amount of the invoice
overwrite	boolean	no	Controls whether an invoice is to be overwritten
invoiceType	String	no	Specifies the type of invoice uploaded to the marketplace, if supported. Accepted values: REGULAR_INVOICE (default) or COMMERCIAL_INVOICE.

Output

Method returns a "PlaceInvoiceResult"

Example (SOAP-UI)

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4_2.seller.api.channelpilot.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <v4:placeInvoice>
         <auth>
            <merchantId>xxxxxxxxxx</merchantId>
            <shopToken>xxxxxxxxxxxxxxxxxxxxxxxxxx</shopToken>
         </auth>
         <externalOrderId>abc-def-ghi</externalOrderId>
         <channel>amazon.de</channel>
         <invoiceContent>CONTENT_AS_BYTE_ARRAY</invoiceContent>
         <invoiceNumber>123456</invoiceNumber>
         <fileName>invoice_123.pdf</fileName>
         <totalAmount>123.30</totalAmount>
         <totalVatAmount>19.69</totalVatAmount>
         <overwrite>false</overwrite>
         <invoiceType>REGULAR_INVOICE</invoiceType>
      </v4:placeInvoice>
   </soapenv:Body>
</soapenv:Envelope>

Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
	<soap:Body>
		<ns1:placeInvoiceResponse xmlns:ns1="http://v4_2.seller.api.channelpilot.com/">
			<return>
				<header>
					<resultCode>200</resultCode>
					<resultMessage/>
				</header>
			</return>
		</ns1:placeInvoiceResponse>
	</soap:Body>
</soap:Envelope>