BrightofficeAPI

Click here for a complete list of operations.

UpdateDebtorTransaction

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

<?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>
    <UpdateDebtorTransaction xmlns="http://tempuri.org/">
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
      <pRequest>
        <DebtorTransactionCode>string</DebtorTransactionCode>
        <OrderNumber>string</OrderNumber>
        <OriginalReference>string</OriginalReference>
        <Details>string</Details>
        <WorkflowStep>string</WorkflowStep>
        <Address>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Address4>string</Address4>
          <PostCode>string</PostCode>
        </Address>
        <ThirdPartyDetails>
          <TransactionThirdPartyDetails>
            <Id>int</Id>
            <DebtorServiceInvoiceCode>string</DebtorServiceInvoiceCode>
            <PayeeName>string</PayeeName>
            <PayeeSurname>string</PayeeSurname>
            <HouseNumber>string</HouseNumber>
            <HouseName>string</HouseName>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <PostCode>string</PostCode>
            <AccountName>string</AccountName>
            <AccountNo>string</AccountNo>
            <SortCode>string</SortCode>
            <Email>string</Email>
          </TransactionThirdPartyDetails>
          <TransactionThirdPartyDetails>
            <Id>int</Id>
            <DebtorServiceInvoiceCode>string</DebtorServiceInvoiceCode>
            <PayeeName>string</PayeeName>
            <PayeeSurname>string</PayeeSurname>
            <HouseNumber>string</HouseNumber>
            <HouseName>string</HouseName>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <PostCode>string</PostCode>
            <AccountName>string</AccountName>
            <AccountNo>string</AccountNo>
            <SortCode>string</SortCode>
            <Email>string</Email>
          </TransactionThirdPartyDetails>
        </ThirdPartyDetails>
      </pRequest>
    </UpdateDebtorTransaction>
  </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>
    <UpdateDebtorTransactionResponse xmlns="http://tempuri.org/">
      <UpdateDebtorTransactionResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <ThirdPartyDetails>
          <TransactionThirdPartyDetails>
            <Id>int</Id>
            <DebtorServiceInvoiceCode>string</DebtorServiceInvoiceCode>
            <PayeeName>string</PayeeName>
            <PayeeSurname>string</PayeeSurname>
            <HouseNumber>string</HouseNumber>
            <HouseName>string</HouseName>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <PostCode>string</PostCode>
            <AccountName>string</AccountName>
            <AccountNo>string</AccountNo>
            <SortCode>string</SortCode>
            <Email>string</Email>
          </TransactionThirdPartyDetails>
          <TransactionThirdPartyDetails>
            <Id>int</Id>
            <DebtorServiceInvoiceCode>string</DebtorServiceInvoiceCode>
            <PayeeName>string</PayeeName>
            <PayeeSurname>string</PayeeSurname>
            <HouseNumber>string</HouseNumber>
            <HouseName>string</HouseName>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <PostCode>string</PostCode>
            <AccountName>string</AccountName>
            <AccountNo>string</AccountNo>
            <SortCode>string</SortCode>
            <Email>string</Email>
          </TransactionThirdPartyDetails>
        </ThirdPartyDetails>
      </UpdateDebtorTransactionResult>
    </UpdateDebtorTransactionResponse>
  </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>
    <UpdateDebtorTransaction xmlns="http://tempuri.org/">
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
      <pRequest>
        <DebtorTransactionCode>string</DebtorTransactionCode>
        <OrderNumber>string</OrderNumber>
        <OriginalReference>string</OriginalReference>
        <Details>string</Details>
        <WorkflowStep>string</WorkflowStep>
        <Address>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Address4>string</Address4>
          <PostCode>string</PostCode>
        </Address>
        <ThirdPartyDetails>
          <TransactionThirdPartyDetails>
            <Id>int</Id>
            <DebtorServiceInvoiceCode>string</DebtorServiceInvoiceCode>
            <PayeeName>string</PayeeName>
            <PayeeSurname>string</PayeeSurname>
            <HouseNumber>string</HouseNumber>
            <HouseName>string</HouseName>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <PostCode>string</PostCode>
            <AccountName>string</AccountName>
            <AccountNo>string</AccountNo>
            <SortCode>string</SortCode>
            <Email>string</Email>
          </TransactionThirdPartyDetails>
          <TransactionThirdPartyDetails>
            <Id>int</Id>
            <DebtorServiceInvoiceCode>string</DebtorServiceInvoiceCode>
            <PayeeName>string</PayeeName>
            <PayeeSurname>string</PayeeSurname>
            <HouseNumber>string</HouseNumber>
            <HouseName>string</HouseName>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <PostCode>string</PostCode>
            <AccountName>string</AccountName>
            <AccountNo>string</AccountNo>
            <SortCode>string</SortCode>
            <Email>string</Email>
          </TransactionThirdPartyDetails>
        </ThirdPartyDetails>
      </pRequest>
    </UpdateDebtorTransaction>
  </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>
    <UpdateDebtorTransactionResponse xmlns="http://tempuri.org/">
      <UpdateDebtorTransactionResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <ThirdPartyDetails>
          <TransactionThirdPartyDetails>
            <Id>int</Id>
            <DebtorServiceInvoiceCode>string</DebtorServiceInvoiceCode>
            <PayeeName>string</PayeeName>
            <PayeeSurname>string</PayeeSurname>
            <HouseNumber>string</HouseNumber>
            <HouseName>string</HouseName>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <PostCode>string</PostCode>
            <AccountName>string</AccountName>
            <AccountNo>string</AccountNo>
            <SortCode>string</SortCode>
            <Email>string</Email>
          </TransactionThirdPartyDetails>
          <TransactionThirdPartyDetails>
            <Id>int</Id>
            <DebtorServiceInvoiceCode>string</DebtorServiceInvoiceCode>
            <PayeeName>string</PayeeName>
            <PayeeSurname>string</PayeeSurname>
            <HouseNumber>string</HouseNumber>
            <HouseName>string</HouseName>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <PostCode>string</PostCode>
            <AccountName>string</AccountName>
            <AccountNo>string</AccountNo>
            <SortCode>string</SortCode>
            <Email>string</Email>
          </TransactionThirdPartyDetails>
        </ThirdPartyDetails>
      </UpdateDebtorTransactionResult>
    </UpdateDebtorTransactionResponse>
  </soap12:Body>
</soap12:Envelope>