UpdateCharge

This API call allows you to update a charge on an invoice.

Tags: UpdateCharge, UpdateInvoiceCharge, UpdateInvoiceChargeActionDate, UpdateInvoiceChargeCountAndTotalPrice, UpdateInvoiceChargeProfitCenter, UpdateInvoiceChargeContainer, UpdateInvoiceChargeComment, UpdateInvoiceChargeArticleGroup, UpdateChargeResponse, UpdateInvoiceChargeResult, UpdateInvoiceChargeError

Request XML

POST /xxx/Automation.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/Automation/UpdateCharge"

<?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>
    <UpdateCharge xmlns="http://ongoingsystems.se/Automation">
      <UserName>string</UserName>
      <Password>string</Password>
      <UpdateInvoiceCharge>
        <ChargeId>int</ChargeId>
        <UpdateInvoiceChargeActionDate>
          <ActionDate>dateTime</ActionDate>
        </UpdateInvoiceChargeActionDate>
        <UpdateInvoiceChargeCountAndTotalPrice>
          <Count>decimal</Count>
          <TotalPrice>decimal</TotalPrice>
        </UpdateInvoiceChargeCountAndTotalPrice>
        <UpdateInvoiceChargeProfitCenter>
          <ProfitCenterId>int</ProfitCenterId>
        </UpdateInvoiceChargeProfitCenter>
        <UpdateInvoiceChargeContainer>
          <Container>string</Container>
        </UpdateInvoiceChargeContainer>
        <UpdateInvoiceChargeComment>
          <Comment>string</Comment>
        </UpdateInvoiceChargeComment>
        <UpdateInvoiceChargeArticleGroup>
          <ArticleGroupId>int</ArticleGroupId>
        </UpdateInvoiceChargeArticleGroup>
      </UpdateInvoiceCharge>
    </UpdateCharge>
  </soap:Body>
</soap:Envelope>

Request specification

UpdateCharge
UserName string(50) Req. Your username
Password string(50) Req. Your password
UpdateInvoiceCharge UpdateInvoiceCharge Req.
UpdateInvoiceCharge
ChargeId int Ongoing WMS internal id of the charge you wish to update.
UpdateInvoiceChargeActionDate UpdateInvoiceChargeActionDate An element of type UpdateInvoiceChargeActionDate.
UpdateInvoiceChargeCountAndTotalPrice UpdateInvoiceChargeCountAndTotalPrice Used to update the count and total price of a charge. Note that you must specify BOTH the count and the total price.
UpdateInvoiceChargeProfitCenter UpdateInvoiceChargeProfitCenter An element of type UpdateInvoiceChargeProfitCenter.
UpdateInvoiceChargeContainer UpdateInvoiceChargeContainer An element of type UpdateInvoiceChargeContainer.
UpdateInvoiceChargeComment UpdateInvoiceChargeComment An element of type UpdateInvoiceChargeComment.
UpdateInvoiceChargeArticleGroup UpdateInvoiceChargeArticleGroup An element of type UpdateInvoiceChargeArticleGroup.
UpdateInvoiceChargeActionDate
ActionDate dateTime The action date of the charge.
UpdateInvoiceChargeCountAndTotalPrice
Count decimal The total count of this charge (not difference).
TotalPrice decimal The new total price of the charge.
UpdateInvoiceChargeProfitCenter
ProfitCenterId int The Ongoing WMS internal id of the profit center.
UpdateInvoiceChargeContainer
Container string(50) The container reference of the charge.
UpdateInvoiceChargeComment
Comment string(1000) The comment of the charge.
UpdateInvoiceChargeArticleGroup
ArticleGroupId int The Ongoing WMS internal id of the article group.

Response XML

<?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>
    <UpdateChargeResponse xmlns="http://ongoingsystems.se/Automation">
      <UpdateChargeResult>
        <Success>boolean</Success>
        <Message>string</Message>
        <ChargeId>int</ChargeId>
        <Errors>
          <UpdateInvoiceChargeError>
            <Message>string</Message>
            <ErrorType>UnknownError or ChargeIdIsNull or ChargeNotFound or InvalidFieldValue</ErrorType>
          </UpdateInvoiceChargeError>
          <UpdateInvoiceChargeError>
            <Message>string</Message>
            <ErrorType>UnknownError or ChargeIdIsNull or ChargeNotFound or InvalidFieldValue</ErrorType>
          </UpdateInvoiceChargeError>
        </Errors>
      </UpdateChargeResult>
    </UpdateChargeResponse>
  </soap:Body>
</soap:Envelope>

Response specification

UpdateChargeResponse
UpdateChargeResult UpdateInvoiceChargeResult
UpdateInvoiceChargeResult
Success boolean True if successful, false otherwise.
Message string Error message, if the call was unsuccessful.
ChargeId int The charge id which was updated.
Errors UpdateInvoiceChargeError[] List of UpdateInvoiceChargeError.
UpdateInvoiceChargeError
Message string Error message, if the call was unsuccessful.
ErrorType enum The type of error:
  • UnknownError
  • ChargeIdIsNull
  • ChargeNotFound
  • InvalidFieldValue