subContractPaymentRequestEntry Web Service

subContractPaymentRequestEntry

Click here for a complete list of operations.

getPaymentRequestByExactID

Returns a single PJPAYHDR entry

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 /ctapi/services/ctDynamicsSL/subcontractPaymentRequestEntry.asmx HTTP/1.1
Host: www.catalinatechnology.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.catalinatechnology.com/services/ctDynamicsSL/getPaymentRequestByExactID"

<?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:Header>
    <ctDynamicsSLHeader xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <licenseKey>string</licenseKey>
      <licenseName>string</licenseName>
      <licenseExpiration>string</licenseExpiration>
      <softwareName>string</softwareName>
      <siteID>string</siteID>
      <siteKey>string</siteKey>
      <userName>string</userName>
      <cpnyID>string</cpnyID>
      <apiUsername>string</apiUsername>
      <apiPassword>string</apiPassword>
      <flags>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
      </flags>
    </ctDynamicsSLHeader>
  </soap:Header>
  <soap:Body>
    <getPaymentRequestByExactID xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <projectID>string</projectID>
      <subcontract>string</subcontract>
      <payReqNbr>string</payReqNbr>
    </getPaymentRequestByExactID>
  </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>
    <getPaymentRequestByExactIDResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getPaymentRequestByExactIDResult>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <counter>int</counter>
        <totalEntries>int</totalEntries>
        <totalPages>int</totalPages>
        <resultCode>int</resultCode>
        <approver>string</approver>
        <BaseCuryId>string</BaseCuryId>
        <batnbr>string</batnbr>
        <bill_inv_num>string</bill_inv_num>
        <crtd_datetime>dateTime</crtd_datetime>
        <crtd_prog>string</crtd_prog>
        <crtd_user>string</crtd_user>
        <curr_net_amt>double</curr_net_amt>
        <curr_ret_amt>double</curr_ret_amt>
        <curr_total_amt>double</curr_total_amt>
        <curr_units>double</curr_units>
        <Curycurr_net_amt>double</Curycurr_net_amt>
        <Curycurr_ret_amt>double</Curycurr_ret_amt>
        <Curycurr_total_amt>double</Curycurr_total_amt>
        <CuryEffDate>dateTime</CuryEffDate>
        <CuryId>string</CuryId>
        <CuryMultDiv>string</CuryMultDiv>
        <CuryRate>double</CuryRate>
        <CuryRateType>string</CuryRateType>
        <date_submitted>dateTime</date_submitted>
        <inv_paid_flag>string</inv_paid_flag>
        <invoice_date>dateTime</invoice_date>
        <lupd_datetime>dateTime</lupd_datetime>
        <lupd_prog>string</lupd_prog>
        <lupd_user>string</lupd_user>
        <noteid>int</noteid>
        <override_reason>string</override_reason>
        <override_vendid>string</override_vendid>
        <payreq_desc>string</payreq_desc>
        <payreq_type_cd>string</payreq_type_cd>
        <payreqnbr>string</payreqnbr>
        <preparer>string</preparer>
        <project>string</project>
        <py_id01>string</py_id01>
        <py_id02>string</py_id02>
        <py_id03>string</py_id03>
        <py_id04>string</py_id04>
        <py_id05>string</py_id05>
        <py_id06>double</py_id06>
        <py_id07>double</py_id07>
        <py_id08>dateTime</py_id08>
        <py_id09>dateTime</py_id09>
        <py_id10>int</py_id10>
        <py_id11>string</py_id11>
        <py_id12>string</py_id12>
        <py_id13>string</py_id13>
        <py_id14>string</py_id14>
        <py_id15>string</py_id15>
        <py_id16>double</py_id16>
        <py_id17>double</py_id17>
        <py_id18>dateTime</py_id18>
        <py_id19>dateTime</py_id19>
        <py_id20>int</py_id20>
        <refnbr>string</refnbr>
        <refnbr_ret>string</refnbr_ret>
        <status1>string</status1>
        <status2>string</status2>
        <subcontract>string</subcontract>
        <user1>string</user1>
        <user2>string</user2>
        <user3>double</user3>
        <user4>double</user4>
        <user5>string</user5>
        <user6>string</user6>
        <user7>double</user7>
        <user8>double</user8>
        <vendid>string</vendid>
        <vendor_invref>string</vendor_invref>
      </getPaymentRequestByExactIDResult>
    </getPaymentRequestByExactIDResponse>
  </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 /ctapi/services/ctDynamicsSL/subcontractPaymentRequestEntry.asmx HTTP/1.1
Host: www.catalinatechnology.com
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:Header>
    <ctDynamicsSLHeader xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <licenseKey>string</licenseKey>
      <licenseName>string</licenseName>
      <licenseExpiration>string</licenseExpiration>
      <softwareName>string</softwareName>
      <siteID>string</siteID>
      <siteKey>string</siteKey>
      <userName>string</userName>
      <cpnyID>string</cpnyID>
      <apiUsername>string</apiUsername>
      <apiPassword>string</apiPassword>
      <flags>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
      </flags>
    </ctDynamicsSLHeader>
  </soap12:Header>
  <soap12:Body>
    <getPaymentRequestByExactID xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <projectID>string</projectID>
      <subcontract>string</subcontract>
      <payReqNbr>string</payReqNbr>
    </getPaymentRequestByExactID>
  </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>
    <getPaymentRequestByExactIDResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getPaymentRequestByExactIDResult>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <counter>int</counter>
        <totalEntries>int</totalEntries>
        <totalPages>int</totalPages>
        <resultCode>int</resultCode>
        <approver>string</approver>
        <BaseCuryId>string</BaseCuryId>
        <batnbr>string</batnbr>
        <bill_inv_num>string</bill_inv_num>
        <crtd_datetime>dateTime</crtd_datetime>
        <crtd_prog>string</crtd_prog>
        <crtd_user>string</crtd_user>
        <curr_net_amt>double</curr_net_amt>
        <curr_ret_amt>double</curr_ret_amt>
        <curr_total_amt>double</curr_total_amt>
        <curr_units>double</curr_units>
        <Curycurr_net_amt>double</Curycurr_net_amt>
        <Curycurr_ret_amt>double</Curycurr_ret_amt>
        <Curycurr_total_amt>double</Curycurr_total_amt>
        <CuryEffDate>dateTime</CuryEffDate>
        <CuryId>string</CuryId>
        <CuryMultDiv>string</CuryMultDiv>
        <CuryRate>double</CuryRate>
        <CuryRateType>string</CuryRateType>
        <date_submitted>dateTime</date_submitted>
        <inv_paid_flag>string</inv_paid_flag>
        <invoice_date>dateTime</invoice_date>
        <lupd_datetime>dateTime</lupd_datetime>
        <lupd_prog>string</lupd_prog>
        <lupd_user>string</lupd_user>
        <noteid>int</noteid>
        <override_reason>string</override_reason>
        <override_vendid>string</override_vendid>
        <payreq_desc>string</payreq_desc>
        <payreq_type_cd>string</payreq_type_cd>
        <payreqnbr>string</payreqnbr>
        <preparer>string</preparer>
        <project>string</project>
        <py_id01>string</py_id01>
        <py_id02>string</py_id02>
        <py_id03>string</py_id03>
        <py_id04>string</py_id04>
        <py_id05>string</py_id05>
        <py_id06>double</py_id06>
        <py_id07>double</py_id07>
        <py_id08>dateTime</py_id08>
        <py_id09>dateTime</py_id09>
        <py_id10>int</py_id10>
        <py_id11>string</py_id11>
        <py_id12>string</py_id12>
        <py_id13>string</py_id13>
        <py_id14>string</py_id14>
        <py_id15>string</py_id15>
        <py_id16>double</py_id16>
        <py_id17>double</py_id17>
        <py_id18>dateTime</py_id18>
        <py_id19>dateTime</py_id19>
        <py_id20>int</py_id20>
        <refnbr>string</refnbr>
        <refnbr_ret>string</refnbr_ret>
        <status1>string</status1>
        <status2>string</status2>
        <subcontract>string</subcontract>
        <user1>string</user1>
        <user2>string</user2>
        <user3>double</user3>
        <user4>double</user4>
        <user5>string</user5>
        <user6>string</user6>
        <user7>double</user7>
        <user8>double</user8>
        <vendid>string</vendid>
        <vendor_invref>string</vendor_invref>
      </getPaymentRequestByExactIDResult>
    </getPaymentRequestByExactIDResponse>
  </soap12:Body>
</soap12:Envelope>