BrightofficeAPI Web Service

BrightofficeAPI

Click here for a complete list of operations.

CreateNewSalesInvoice

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/CreateNewSalesInvoice"

<?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>
    <CreateNewSalesInvoice xmlns="http://tempuri.org/">
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
      <Type>string</Type>
      <InvoiceDataRequest>
        <InvoiceCode>string</InvoiceCode>
        <CustomerCode>string</CustomerCode>
        <InvoiceDate>dateTime</InvoiceDate>
        <InvoiceStatusCode>string</InvoiceStatusCode>
        <OrderNumber>string</OrderNumber>
        <ProjectCode>string</ProjectCode>
        <NominalCode>string</NominalCode>
        <MatterTypeCode>string</MatterTypeCode>
        <SourceCode>string</SourceCode>
        <Details>string</Details>
        <NetAmount>double</NetAmount>
        <VatAmount>double</VatAmount>
        <VatRate>double</VatRate>
        <JobCode>string</JobCode>
        <ApplicantCode>string</ApplicantCode>
        <DebtCaseCode>string</DebtCaseCode>
        <DMFee>double</DMFee>
        <DeptCode>string</DeptCode>
        <ProductLines>
          <InvoiceProductLineApi>
            <Code>string</Code>
            <ProductInvoiceCode>string</ProductInvoiceCode>
            <Qty>int</Qty>
            <Item>string</Item>
            <ProductCode>string</ProductCode>
            <ProductDescription>string</ProductDescription>
            <VATCode>string</VATCode>
            <Header>string</Header>
            <SubHeader>string</SubHeader>
            <Category>string</Category>
            <ItemReference>string</ItemReference>
            <Notes>string</Notes>
            <UnitCost>double</UnitCost>
            <NetAmount>double</NetAmount>
            <VatAmount>double</VatAmount>
            <TotalAmount>double</TotalAmount>
            <VatRate>double</VatRate>
            <SalesNominalCode>string</SalesNominalCode>
            <Excluded>boolean</Excluded>
          </InvoiceProductLineApi>
          <InvoiceProductLineApi>
            <Code>string</Code>
            <ProductInvoiceCode>string</ProductInvoiceCode>
            <Qty>int</Qty>
            <Item>string</Item>
            <ProductCode>string</ProductCode>
            <ProductDescription>string</ProductDescription>
            <VATCode>string</VATCode>
            <Header>string</Header>
            <SubHeader>string</SubHeader>
            <Category>string</Category>
            <ItemReference>string</ItemReference>
            <Notes>string</Notes>
            <UnitCost>double</UnitCost>
            <NetAmount>double</NetAmount>
            <VatAmount>double</VatAmount>
            <TotalAmount>double</TotalAmount>
            <VatRate>double</VatRate>
            <SalesNominalCode>string</SalesNominalCode>
            <Excluded>boolean</Excluded>
          </InvoiceProductLineApi>
        </ProductLines>
      </InvoiceDataRequest>
    </CreateNewSalesInvoice>
  </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>
    <CreateNewSalesInvoiceResponse xmlns="http://tempuri.org/">
      <CreateNewSalesInvoiceResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <Value>string</Value>
      </CreateNewSalesInvoiceResult>
    </CreateNewSalesInvoiceResponse>
  </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>
    <CreateNewSalesInvoice xmlns="http://tempuri.org/">
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
      <Type>string</Type>
      <InvoiceDataRequest>
        <InvoiceCode>string</InvoiceCode>
        <CustomerCode>string</CustomerCode>
        <InvoiceDate>dateTime</InvoiceDate>
        <InvoiceStatusCode>string</InvoiceStatusCode>
        <OrderNumber>string</OrderNumber>
        <ProjectCode>string</ProjectCode>
        <NominalCode>string</NominalCode>
        <MatterTypeCode>string</MatterTypeCode>
        <SourceCode>string</SourceCode>
        <Details>string</Details>
        <NetAmount>double</NetAmount>
        <VatAmount>double</VatAmount>
        <VatRate>double</VatRate>
        <JobCode>string</JobCode>
        <ApplicantCode>string</ApplicantCode>
        <DebtCaseCode>string</DebtCaseCode>
        <DMFee>double</DMFee>
        <DeptCode>string</DeptCode>
        <ProductLines>
          <InvoiceProductLineApi>
            <Code>string</Code>
            <ProductInvoiceCode>string</ProductInvoiceCode>
            <Qty>int</Qty>
            <Item>string</Item>
            <ProductCode>string</ProductCode>
            <ProductDescription>string</ProductDescription>
            <VATCode>string</VATCode>
            <Header>string</Header>
            <SubHeader>string</SubHeader>
            <Category>string</Category>
            <ItemReference>string</ItemReference>
            <Notes>string</Notes>
            <UnitCost>double</UnitCost>
            <NetAmount>double</NetAmount>
            <VatAmount>double</VatAmount>
            <TotalAmount>double</TotalAmount>
            <VatRate>double</VatRate>
            <SalesNominalCode>string</SalesNominalCode>
            <Excluded>boolean</Excluded>
          </InvoiceProductLineApi>
          <InvoiceProductLineApi>
            <Code>string</Code>
            <ProductInvoiceCode>string</ProductInvoiceCode>
            <Qty>int</Qty>
            <Item>string</Item>
            <ProductCode>string</ProductCode>
            <ProductDescription>string</ProductDescription>
            <VATCode>string</VATCode>
            <Header>string</Header>
            <SubHeader>string</SubHeader>
            <Category>string</Category>
            <ItemReference>string</ItemReference>
            <Notes>string</Notes>
            <UnitCost>double</UnitCost>
            <NetAmount>double</NetAmount>
            <VatAmount>double</VatAmount>
            <TotalAmount>double</TotalAmount>
            <VatRate>double</VatRate>
            <SalesNominalCode>string</SalesNominalCode>
            <Excluded>boolean</Excluded>
          </InvoiceProductLineApi>
        </ProductLines>
      </InvoiceDataRequest>
    </CreateNewSalesInvoice>
  </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>
    <CreateNewSalesInvoiceResponse xmlns="http://tempuri.org/">
      <CreateNewSalesInvoiceResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <Value>string</Value>
      </CreateNewSalesInvoiceResult>
    </CreateNewSalesInvoiceResponse>
  </soap12:Body>
</soap12:Envelope>