soap
Click here for a complete list of operations.
GetInvoiceList
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /soap.asmx HTTP/1.1 Host: api.pixelz.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://removethebackground.com/GetInvoiceList" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetInvoiceList xmlns="http://removethebackground.com/"> <contactEmail>string</contactEmail> <contactAPIkey>string</contactAPIkey> <fromDate>string</fromDate> <toDate>string</toDate> <page>string</page> <returnUrl>string</returnUrl> </GetInvoiceList> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetInvoiceListResponse xmlns="http://removethebackground.com/"> <GetInvoiceListResult> <Invoices> <Invoice> <InvoiceId>string</InvoiceId> <CreatedDate>string</CreatedDate> <AmountDue>string</AmountDue> <IsPaid>boolean</IsPaid> <PaymentUrl>string</PaymentUrl> <InvoiceUrl>string</InvoiceUrl> </Invoice> <Invoice> <InvoiceId>string</InvoiceId> <CreatedDate>string</CreatedDate> <AmountDue>string</AmountDue> <IsPaid>boolean</IsPaid> <PaymentUrl>string</PaymentUrl> <InvoiceUrl>string</InvoiceUrl> </Invoice> </Invoices> </GetInvoiceListResult> </GetInvoiceListResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /soap.asmx HTTP/1.1 Host: api.pixelz.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetInvoiceList xmlns="http://removethebackground.com/"> <contactEmail>string</contactEmail> <contactAPIkey>string</contactAPIkey> <fromDate>string</fromDate> <toDate>string</toDate> <page>string</page> <returnUrl>string</returnUrl> </GetInvoiceList> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetInvoiceListResponse xmlns="http://removethebackground.com/"> <GetInvoiceListResult> <Invoices> <Invoice> <InvoiceId>string</InvoiceId> <CreatedDate>string</CreatedDate> <AmountDue>string</AmountDue> <IsPaid>boolean</IsPaid> <PaymentUrl>string</PaymentUrl> <InvoiceUrl>string</InvoiceUrl> </Invoice> <Invoice> <InvoiceId>string</InvoiceId> <CreatedDate>string</CreatedDate> <AmountDue>string</AmountDue> <IsPaid>boolean</IsPaid> <PaymentUrl>string</PaymentUrl> <InvoiceUrl>string</InvoiceUrl> </Invoice> </Invoices> </GetInvoiceListResult> </GetInvoiceListResponse> </soap12:Body> </soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /soap.asmx/GetInvoiceList?contactEmail=string&contactAPIkey=string&fromDate=string&toDate=string&page=string&returnUrl=string HTTP/1.1 Host: api.pixelz.com
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <InvoiceListResponse xmlns="http://removethebackground.com/"> <Invoices> <Invoice> <InvoiceId>string</InvoiceId> <CreatedDate>string</CreatedDate> <AmountDue>string</AmountDue> <IsPaid>boolean</IsPaid> <PaymentUrl>string</PaymentUrl> <InvoiceUrl>string</InvoiceUrl> </Invoice> <Invoice> <InvoiceId>string</InvoiceId> <CreatedDate>string</CreatedDate> <AmountDue>string</AmountDue> <IsPaid>boolean</IsPaid> <PaymentUrl>string</PaymentUrl> <InvoiceUrl>string</InvoiceUrl> </Invoice> </Invoices> </InvoiceListResponse>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /soap.asmx/GetInvoiceList HTTP/1.1 Host: api.pixelz.com Content-Type: application/x-www-form-urlencoded Content-Length: length contactEmail=string&contactAPIkey=string&fromDate=string&toDate=string&page=string&returnUrl=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <InvoiceListResponse xmlns="http://removethebackground.com/"> <Invoices> <Invoice> <InvoiceId>string</InvoiceId> <CreatedDate>string</CreatedDate> <AmountDue>string</AmountDue> <IsPaid>boolean</IsPaid> <PaymentUrl>string</PaymentUrl> <InvoiceUrl>string</InvoiceUrl> </Invoice> <Invoice> <InvoiceId>string</InvoiceId> <CreatedDate>string</CreatedDate> <AmountDue>string</AmountDue> <IsPaid>boolean</IsPaid> <PaymentUrl>string</PaymentUrl> <InvoiceUrl>string</InvoiceUrl> </Invoice> </Invoices> </InvoiceListResponse>