BrightofficeAPI

Click here for a complete list of operations.

CreateSalesOrder

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 /Webservices/BrightOfficeAPI.asmx HTTP/1.1
Host: www.spdoffice.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/CreateSalesOrder"

<?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>
    <CreateSalesOrder xmlns="http://tempuri.org/">
      <SalesOrderParentDetails>
        <CustomerCode>string</CustomerCode>
        <SalesOrderReference>string</SalesOrderReference>
        <OrderDate>dateTime</OrderDate>
        <NetAmount>double</NetAmount>
        <VatAmount>double</VatAmount>
        <TotalAmount>double</TotalAmount>
        <Balance>double</Balance>
        <StatusDescription>string</StatusDescription>
        <Status>string</Status>
      </SalesOrderParentDetails>
      <SalesOrderProductDetails>
        <SalesOrderProduct>
          <ProductCode>string</ProductCode>
          <ProductDescription>string</ProductDescription>
          <ProductQty>int</ProductQty>
          <SellingPrice>double</SellingPrice>
          <VatCode>string</VatCode>
          <VatRate>double</VatRate>
        </SalesOrderProduct>
        <SalesOrderProduct>
          <ProductCode>string</ProductCode>
          <ProductDescription>string</ProductDescription>
          <ProductQty>int</ProductQty>
          <SellingPrice>double</SellingPrice>
          <VatCode>string</VatCode>
          <VatRate>double</VatRate>
        </SalesOrderProduct>
      </SalesOrderProductDetails>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </CreateSalesOrder>
  </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>
    <CreateSalesOrderResponse xmlns="http://tempuri.org/">
      <CreateSalesOrderResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <Records>
          <anyType />
          <anyType />
        </Records>
        <TotalRecordCount>int</TotalRecordCount>
      </CreateSalesOrderResult>
    </CreateSalesOrderResponse>
  </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 /Webservices/BrightOfficeAPI.asmx HTTP/1.1
Host: www.spdoffice.co.uk
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>
    <CreateSalesOrder xmlns="http://tempuri.org/">
      <SalesOrderParentDetails>
        <CustomerCode>string</CustomerCode>
        <SalesOrderReference>string</SalesOrderReference>
        <OrderDate>dateTime</OrderDate>
        <NetAmount>double</NetAmount>
        <VatAmount>double</VatAmount>
        <TotalAmount>double</TotalAmount>
        <Balance>double</Balance>
        <StatusDescription>string</StatusDescription>
        <Status>string</Status>
      </SalesOrderParentDetails>
      <SalesOrderProductDetails>
        <SalesOrderProduct>
          <ProductCode>string</ProductCode>
          <ProductDescription>string</ProductDescription>
          <ProductQty>int</ProductQty>
          <SellingPrice>double</SellingPrice>
          <VatCode>string</VatCode>
          <VatRate>double</VatRate>
        </SalesOrderProduct>
        <SalesOrderProduct>
          <ProductCode>string</ProductCode>
          <ProductDescription>string</ProductDescription>
          <ProductQty>int</ProductQty>
          <SellingPrice>double</SellingPrice>
          <VatCode>string</VatCode>
          <VatRate>double</VatRate>
        </SalesOrderProduct>
      </SalesOrderProductDetails>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </CreateSalesOrder>
  </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>
    <CreateSalesOrderResponse xmlns="http://tempuri.org/">
      <CreateSalesOrderResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <Records>
          <anyType />
          <anyType />
        </Records>
        <TotalRecordCount>int</TotalRecordCount>
      </CreateSalesOrderResult>
    </CreateSalesOrderResponse>
  </soap12:Body>
</soap12:Envelope>