BrightofficeAPI


Click here for a complete list of operations.

GetDTInvoiceTerms

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

<?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>
    <GetDTInvoiceTerms xmlns="http://tempuri.org/">
      <DebtorTransactionCode>string</DebtorTransactionCode>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </GetDTInvoiceTerms>
  </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>
    <GetDTInvoiceTermsResponse xmlns="http://tempuri.org/">
      <GetDTInvoiceTermsResult>
        <RecurringPaymentSet>boolean</RecurringPaymentSet>
        <Terms>
          <InvoiceTermItem>
            <TermDueDate>string</TermDueDate>
            <TermAmountDue>double</TermAmountDue>
            <TermAmountPaid>double</TermAmountPaid>
            <TermAmountBalance>double</TermAmountBalance>
            <LinkedTransactions xsi:nil="true" />
          </InvoiceTermItem>
          <InvoiceTermItem>
            <TermDueDate>string</TermDueDate>
            <TermAmountDue>double</TermAmountDue>
            <TermAmountPaid>double</TermAmountPaid>
            <TermAmountBalance>double</TermAmountBalance>
            <LinkedTransactions xsi:nil="true" />
          </InvoiceTermItem>
        </Terms>
        <RefundTransactions>
          <RefundTransactionDetails>
            <Reference>string</Reference>
            <RefundAmount>double</RefundAmount>
            <RefundDate>string</RefundDate>
          </RefundTransactionDetails>
          <RefundTransactionDetails>
            <Reference>string</Reference>
            <RefundAmount>double</RefundAmount>
            <RefundDate>string</RefundDate>
          </RefundTransactionDetails>
        </RefundTransactions>
        <Result>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </Result>
      </GetDTInvoiceTermsResult>
    </GetDTInvoiceTermsResponse>
  </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>
    <GetDTInvoiceTerms xmlns="http://tempuri.org/">
      <DebtorTransactionCode>string</DebtorTransactionCode>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </GetDTInvoiceTerms>
  </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>
    <GetDTInvoiceTermsResponse xmlns="http://tempuri.org/">
      <GetDTInvoiceTermsResult>
        <RecurringPaymentSet>boolean</RecurringPaymentSet>
        <Terms>
          <InvoiceTermItem>
            <TermDueDate>string</TermDueDate>
            <TermAmountDue>double</TermAmountDue>
            <TermAmountPaid>double</TermAmountPaid>
            <TermAmountBalance>double</TermAmountBalance>
            <LinkedTransactions xsi:nil="true" />
          </InvoiceTermItem>
          <InvoiceTermItem>
            <TermDueDate>string</TermDueDate>
            <TermAmountDue>double</TermAmountDue>
            <TermAmountPaid>double</TermAmountPaid>
            <TermAmountBalance>double</TermAmountBalance>
            <LinkedTransactions xsi:nil="true" />
          </InvoiceTermItem>
        </Terms>
        <RefundTransactions>
          <RefundTransactionDetails>
            <Reference>string</Reference>
            <RefundAmount>double</RefundAmount>
            <RefundDate>string</RefundDate>
          </RefundTransactionDetails>
          <RefundTransactionDetails>
            <Reference>string</Reference>
            <RefundAmount>double</RefundAmount>
            <RefundDate>string</RefundDate>
          </RefundTransactionDetails>
        </RefundTransactions>
        <Result>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </Result>
      </GetDTInvoiceTermsResult>
    </GetDTInvoiceTermsResponse>
  </soap12:Body>
</soap12:Envelope>