GetInvoice
Description
This method returns the invoice in PDF format.
SOAP API:
Action
http://shoxl.com/ShoxlService/GetInvoice
Please note: this is not a working url, but a combination of namespace and method. Do not expect the url to return a result.
Style
Document
Input (Literal)
The input of this method is the document element tns:GetInvoice having the structure defined by the following table.
Element
Type
Occurs
Description
Sequence
1..1
request
tns:GetInvoiceRequest
0..1
Complex Type: tns:GetInvoiceRequest
Description
The GetInvoiceRequest contains all the information needed to get the
order details of a single order.
Component
Type
Occurs
Description
Sequence
1..1
InvoiceNumber
s:string
1..1
A unique invoice number
CustomerNumber
s:string
1..1
A unique customer number
Output (Literal)
The output of this method is the document element tns:GetInvoiceResponse having the structure defined by the following table.
Element
Type
Occurs
Description
Sequence
1..1
GetInvoiceResult
tns:GetInvoiceResult
0..1
Complex Type: tns:GetInvoiceResult
Description
The GetInvoiceResult returns the invoice details of the given invoice number, including the invoice itself as an embedded PDF..
Component
Type
Occurs
Description
Sequence
1..1
ErrorCode
s:string
0..1
An error code returned by the ERP system
ErrorDescription
s:string
0..1
The error description related to the error code returned by the ERP system
InvoicePDF
s:base64Binary
1..1
The PDF containing the invoice
Request
tns:GetInvoiceRequest
1..1
The sent request by Shoxl Shop.
REST API:
URL: /Shoxl/v1/GetInvoice Method: POST
Request body:
GetInvoiceRequest{
parameter
type
invoiceNumber
string required
customerNumber
string required
}
Example:
Response body:
GetInvoiceResult{
parameter
type
errorCode
string nullable: true
errorDescription
string nullable: true
invoicePDF
string($byte) required
request
GetInvoiceRequest
}
GetInvoiceRequest{
parameter
type
invoiceNumber
string nullable: true
customerNumber
string nullable: true
}