BrightofficeAPI

Click here for a complete list of operations.

UpdateDebtor

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

<?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>
    <UpdateDebtor xmlns="http://tempuri.org/">
      <Debtor>
        <DebtorCode>string</DebtorCode>
        <CustomerCode>string</CustomerCode>
        <CustomerName>string</CustomerName>
        <Title1>string</Title1>
        <Firstname>string</Firstname>
        <Surname>string</Surname>
        <Title2>string</Title2>
        <Firstname2>string</Firstname2>
        <Surname2>string</Surname2>
        <DebtorAddress>
          <HouseName>string</HouseName>
          <HouseNumber>string</HouseNumber>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Address4>string</Address4>
          <Address5>string</Address5>
          <PostCode>string</PostCode>
        </DebtorAddress>
        <Currency>string</Currency>
        <DateCreated>dateTime</DateCreated>
        <OldReference>string</OldReference>
        <Telephone>string</Telephone>
        <WorkTelephone>string</WorkTelephone>
        <Mobile>string</Mobile>
        <Fax>string</Fax>
        <Email>string</Email>
        <Website>string</Website>
        <DateOfBirth>dateTime</DateOfBirth>
        <NationalInsuranceNumber>string</NationalInsuranceNumber>
        <DebtorStatus>string</DebtorStatus>
        <DebtorTypes>
          <anyType />
          <anyType />
        </DebtorTypes>
        <Notes>string</Notes>
        <Source>string</Source>
        <SourceName>string</SourceName>
        <B2BDebtor>boolean</B2BDebtor>
        <CompanyName>string</CompanyName>
        <StaffCode>string</StaffCode>
        <StaffName>string</StaffName>
        <Salutation>string</Salutation>
        <AlternateSalutation>string</AlternateSalutation>
        <DebtorTransactions>
          <DebtorTransactionMin>
            <DebtorTransactionCode>string</DebtorTransactionCode>
            <InvoiceBalance>decimal</InvoiceBalance>
          </DebtorTransactionMin>
          <DebtorTransactionMin>
            <DebtorTransactionCode>string</DebtorTransactionCode>
            <InvoiceBalance>decimal</InvoiceBalance>
          </DebtorTransactionMin>
        </DebtorTransactions>
        <CustomFields>
          <CustomField>
            <index>int</index>
            <CustomFieldLabel>string</CustomFieldLabel>
            <CustomFieldValue>string</CustomFieldValue>
          </CustomField>
          <CustomField>
            <index>int</index>
            <CustomFieldLabel>string</CustomFieldLabel>
            <CustomFieldValue>string</CustomFieldValue>
          </CustomField>
        </CustomFields>
      </Debtor>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </UpdateDebtor>
  </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>
    <UpdateDebtorResponse xmlns="http://tempuri.org/">
      <UpdateDebtorResult>
        <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
        <Message>string</Message>
        <ExceptionMessage>string</ExceptionMessage>
        <IsSystemError>boolean</IsSystemError>
      </UpdateDebtorResult>
    </UpdateDebtorResponse>
  </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>
    <UpdateDebtor xmlns="http://tempuri.org/">
      <Debtor>
        <DebtorCode>string</DebtorCode>
        <CustomerCode>string</CustomerCode>
        <CustomerName>string</CustomerName>
        <Title1>string</Title1>
        <Firstname>string</Firstname>
        <Surname>string</Surname>
        <Title2>string</Title2>
        <Firstname2>string</Firstname2>
        <Surname2>string</Surname2>
        <DebtorAddress>
          <HouseName>string</HouseName>
          <HouseNumber>string</HouseNumber>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Address4>string</Address4>
          <Address5>string</Address5>
          <PostCode>string</PostCode>
        </DebtorAddress>
        <Currency>string</Currency>
        <DateCreated>dateTime</DateCreated>
        <OldReference>string</OldReference>
        <Telephone>string</Telephone>
        <WorkTelephone>string</WorkTelephone>
        <Mobile>string</Mobile>
        <Fax>string</Fax>
        <Email>string</Email>
        <Website>string</Website>
        <DateOfBirth>dateTime</DateOfBirth>
        <NationalInsuranceNumber>string</NationalInsuranceNumber>
        <DebtorStatus>string</DebtorStatus>
        <DebtorTypes>
          <anyType />
          <anyType />
        </DebtorTypes>
        <Notes>string</Notes>
        <Source>string</Source>
        <SourceName>string</SourceName>
        <B2BDebtor>boolean</B2BDebtor>
        <CompanyName>string</CompanyName>
        <StaffCode>string</StaffCode>
        <StaffName>string</StaffName>
        <Salutation>string</Salutation>
        <AlternateSalutation>string</AlternateSalutation>
        <DebtorTransactions>
          <DebtorTransactionMin>
            <DebtorTransactionCode>string</DebtorTransactionCode>
            <InvoiceBalance>decimal</InvoiceBalance>
          </DebtorTransactionMin>
          <DebtorTransactionMin>
            <DebtorTransactionCode>string</DebtorTransactionCode>
            <InvoiceBalance>decimal</InvoiceBalance>
          </DebtorTransactionMin>
        </DebtorTransactions>
        <CustomFields>
          <CustomField>
            <index>int</index>
            <CustomFieldLabel>string</CustomFieldLabel>
            <CustomFieldValue>string</CustomFieldValue>
          </CustomField>
          <CustomField>
            <index>int</index>
            <CustomFieldLabel>string</CustomFieldLabel>
            <CustomFieldValue>string</CustomFieldValue>
          </CustomField>
        </CustomFields>
      </Debtor>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </UpdateDebtor>
  </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>
    <UpdateDebtorResponse xmlns="http://tempuri.org/">
      <UpdateDebtorResult>
        <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
        <Message>string</Message>
        <ExceptionMessage>string</ExceptionMessage>
        <IsSystemError>boolean</IsSystemError>
      </UpdateDebtorResult>
    </UpdateDebtorResponse>
  </soap12:Body>
</soap12:Envelope>