Skip to main content

Invoice Status Update - cXML Integration

Permanently deleted user
  • Updated

This topic provides descriptions for elements and attributes required to update the status of an Invoice or Credit Memo via cXML integration.

Introduction

The BuyerQuest platform has the ability to receive Invoice or Credit Memo Status Updates (StatusUpdateRequest) from Client ERP systems via cXML messages. This topic provides descriptions for elements and attributes required to update the status of an Invoice or Credit Memo via cXML integration.

Integration Configuration

In order to receive Invoice Status updates from a Client ERP system, Enable cXML Invoice Status Updates must be set to Yes at:

System Administration > Settings and Configurations > Manage System Configurations > Payables > Invoice Integration

When Enable cXML Invoice Status Updates is set to Yes, values can be entered for the Senders Identity and Senders Shared Secret fields.

The URL to post cXML Invoice Update is:

https://{buyerquest_site_url}/{client}/cxmlgate/abc/status_update_request

StatusUpdateRequest cXML Specification

The details of the inbound StatusUpdateRequest cXML message from the Client ERP and response from the BuyerQuest system are defined below.

Incoming StatusUpdateRequest cXML Fields

Note: Additional allowed values for InvoiceStatus type are rejected and validation_failed.

The value rejected updates the status of the Invoice or Credit Memo to Denied.

The value validation_failed updates the status of the Invoice or Credit Memo to Failed ERP Validation.

The value processing_payment updates the Invoices in Ok to Pay Status to Processing Payment.

 Sample Incoming Message

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE cXML SYSTEM
"http://xml.cXML.org/schemas/cXML/1.2.035/cXML.dtd">
<cXML timestamp="2001-09-05T16:34:28-07:00" payloadID="999732868377--681956365911302107@10.11.128.161">
     <Header>
          <From>
               <Credential domain="BuyerQuestId">
                    <Identity>jill@buyerorg.com</Identity>
               </Credential>
          </From>
          <To>
               <Credential domain="BuyerQuestNetworkUserId">
                    <Identity>jack@supplierorg.com</Identity></Credential>
          </To>
          <Sender>
               <Credential domain="BuyerQuestNetworkUserId">
                    <Identity>jill@buyerorg.com</Identity>
                    <SharedSecret>abracadabra</SharedSecret>
               </Credential>
               <UserAgent>Procurement Application V1.0</UserAgent>
          </Sender>
     </Header>
     <Request>
          <StatusUpdateRequest>
               <DocumentReference payloadID="INV-0001"/>
               <Status code="200" text=""/>
               <InvoiceStatus type="paid">
                    <PartialAmount>
                         <Money currency="USD">10.99</Money>
                    </PartialAmount>
               </InvoiceStatus>
          </StatusUpdateRequest>
     </Request>
</cXML>

Response Message (from BuyerQuest to Client ERP):

<cXML payloadID="9949494" xml:lang="en" timestamp="1999-03-12T18:39:09- 08:00">
     <Response>
          <Status code="200" text="OK"/>
     </Response>
</cXML>

Response Message Codes

Code Number Text
200 OK Standard Success message
200 Invoice Update Already Received Invoice Status Update already received for this Invoice (i.e. Duplicate message)
400 Permanent Error Permanent error. Client should not retry. The error prevents the request from being accepted.
402 Malformed Message XML was not properly formed
403 Invoice Not Found BQ Invoice Number was not found
404 Invoice In Wrong Status Invoice is not in 'Ok2Pay' status
500 Transient Error - Please resend Transient error. Typically a transport error. Client should retry.

 

 

 

Related articles

Comments

0 comments

Article is closed for comments.