ConnectivityPlatform
Click here for a complete list of operations.
GetInvoices
Test
The test form is only available for requests from the local machine.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 /services/ConnectivityPlatform.asmx HTTP/1.1 Host: ws.logistics.banyantechnology.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://www.banyantechnology.com/Services/ConnectivityPlatform/GetInvoices" <?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> <GetInvoices xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/"> <request> <AuthenticationData> <Username>string</Username> <Password>string</Password> <ClientRefNum>string</ClientRefNum> </AuthenticationData> <ProNumber>string</ProNumber> <BOLID>string</BOLID> <LoadID>int</LoadID> <DateFilterType>Created or Pickup or Delivery or Billing</DateFilterType> <StartDate>dateTime</StartDate> <EndDate>dateTime</EndDate> <InvoiceStatusFilter>Approved or Cancelled or Duplicated or Posted or Printed or PaymentSent or Published or Queued or Open or Partial or Disputed or Paid or Closed or WriteOff or Exported or ApprovedDisputed or OpenDisputed or ExportedDisputed or OpenRevEngDisputed or Review</InvoiceStatusFilter> <IgnoreExported>boolean</IgnoreExported> </request> </GetInvoices> </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> <GetInvoicesResponse xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/"> <GetInvoicesResult> <Invoices> <InvoiceData> <ApID>int</ApID> <EDIBillToAccountCode>string</EDIBillToAccountCode> <InvoiceType>string</InvoiceType> <ClientName>string</ClientName> <ClientReferenceNumber>string</ClientReferenceNumber> <InvoiceStatusCode>string</InvoiceStatusCode> <NetAmountDue>decimal</NetAmountDue> <TotalCharges>decimal</TotalCharges> <Variance>decimal</Variance> <CurrencyCode>string</CurrencyCode> <CarrierName>string</CarrierName> <CarrierSCAC>string</CarrierSCAC> <VendorName>string</VendorName> <VendorID>string</VendorID> <HasException>boolean</HasException> <ShipmentCreatedFromInvoice>boolean</ShipmentCreatedFromInvoice> <EDIType>string</EDIType> <CreatedDateTime>dateTime</CreatedDateTime> <BillingDateTime>dateTime</BillingDateTime> <ExportedDateTime>dateTime</ExportedDateTime> <ShipmentDetails xsi:nil="true" /> <QuoteDetails xsi:nil="true" /> <BatchDetails xsi:nil="true" /> <LineItem xsi:nil="true" /> <Payment xsi:nil="true" /> <Address xsi:nil="true" /> <BolAvailable>boolean</BolAvailable> <PodAvailable>boolean</PodAvailable> </InvoiceData> <InvoiceData> <ApID>int</ApID> <EDIBillToAccountCode>string</EDIBillToAccountCode> <InvoiceType>string</InvoiceType> <ClientName>string</ClientName> <ClientReferenceNumber>string</ClientReferenceNumber> <InvoiceStatusCode>string</InvoiceStatusCode> <NetAmountDue>decimal</NetAmountDue> <TotalCharges>decimal</TotalCharges> <Variance>decimal</Variance> <CurrencyCode>string</CurrencyCode> <CarrierName>string</CarrierName> <CarrierSCAC>string</CarrierSCAC> <VendorName>string</VendorName> <VendorID>string</VendorID> <HasException>boolean</HasException> <ShipmentCreatedFromInvoice>boolean</ShipmentCreatedFromInvoice> <EDIType>string</EDIType> <CreatedDateTime>dateTime</CreatedDateTime> <BillingDateTime>dateTime</BillingDateTime> <ExportedDateTime>dateTime</ExportedDateTime> <ShipmentDetails xsi:nil="true" /> <QuoteDetails xsi:nil="true" /> <BatchDetails xsi:nil="true" /> <LineItem xsi:nil="true" /> <Payment xsi:nil="true" /> <Address xsi:nil="true" /> <BolAvailable>boolean</BolAvailable> <PodAvailable>boolean</PodAvailable> </InvoiceData> </Invoices> <Success>boolean</Success> <Error> <Message>string</Message> </Error> </GetInvoicesResult> </GetInvoicesResponse> </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 /services/ConnectivityPlatform.asmx HTTP/1.1 Host: ws.logistics.banyantechnology.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> <GetInvoices xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/"> <request> <AuthenticationData> <Username>string</Username> <Password>string</Password> <ClientRefNum>string</ClientRefNum> </AuthenticationData> <ProNumber>string</ProNumber> <BOLID>string</BOLID> <LoadID>int</LoadID> <DateFilterType>Created or Pickup or Delivery or Billing</DateFilterType> <StartDate>dateTime</StartDate> <EndDate>dateTime</EndDate> <InvoiceStatusFilter>Approved or Cancelled or Duplicated or Posted or Printed or PaymentSent or Published or Queued or Open or Partial or Disputed or Paid or Closed or WriteOff or Exported or ApprovedDisputed or OpenDisputed or ExportedDisputed or OpenRevEngDisputed or Review</InvoiceStatusFilter> <IgnoreExported>boolean</IgnoreExported> </request> </GetInvoices> </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> <GetInvoicesResponse xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/"> <GetInvoicesResult> <Invoices> <InvoiceData> <ApID>int</ApID> <EDIBillToAccountCode>string</EDIBillToAccountCode> <InvoiceType>string</InvoiceType> <ClientName>string</ClientName> <ClientReferenceNumber>string</ClientReferenceNumber> <InvoiceStatusCode>string</InvoiceStatusCode> <NetAmountDue>decimal</NetAmountDue> <TotalCharges>decimal</TotalCharges> <Variance>decimal</Variance> <CurrencyCode>string</CurrencyCode> <CarrierName>string</CarrierName> <CarrierSCAC>string</CarrierSCAC> <VendorName>string</VendorName> <VendorID>string</VendorID> <HasException>boolean</HasException> <ShipmentCreatedFromInvoice>boolean</ShipmentCreatedFromInvoice> <EDIType>string</EDIType> <CreatedDateTime>dateTime</CreatedDateTime> <BillingDateTime>dateTime</BillingDateTime> <ExportedDateTime>dateTime</ExportedDateTime> <ShipmentDetails xsi:nil="true" /> <QuoteDetails xsi:nil="true" /> <BatchDetails xsi:nil="true" /> <LineItem xsi:nil="true" /> <Payment xsi:nil="true" /> <Address xsi:nil="true" /> <BolAvailable>boolean</BolAvailable> <PodAvailable>boolean</PodAvailable> </InvoiceData> <InvoiceData> <ApID>int</ApID> <EDIBillToAccountCode>string</EDIBillToAccountCode> <InvoiceType>string</InvoiceType> <ClientName>string</ClientName> <ClientReferenceNumber>string</ClientReferenceNumber> <InvoiceStatusCode>string</InvoiceStatusCode> <NetAmountDue>decimal</NetAmountDue> <TotalCharges>decimal</TotalCharges> <Variance>decimal</Variance> <CurrencyCode>string</CurrencyCode> <CarrierName>string</CarrierName> <CarrierSCAC>string</CarrierSCAC> <VendorName>string</VendorName> <VendorID>string</VendorID> <HasException>boolean</HasException> <ShipmentCreatedFromInvoice>boolean</ShipmentCreatedFromInvoice> <EDIType>string</EDIType> <CreatedDateTime>dateTime</CreatedDateTime> <BillingDateTime>dateTime</BillingDateTime> <ExportedDateTime>dateTime</ExportedDateTime> <ShipmentDetails xsi:nil="true" /> <QuoteDetails xsi:nil="true" /> <BatchDetails xsi:nil="true" /> <LineItem xsi:nil="true" /> <Payment xsi:nil="true" /> <Address xsi:nil="true" /> <BolAvailable>boolean</BolAvailable> <PodAvailable>boolean</PodAvailable> </InvoiceData> </Invoices> <Success>boolean</Success> <Error> <Message>string</Message> </Error> </GetInvoicesResult> </GetInvoicesResponse> </soap12:Body> </soap12:Envelope>