Document Line Create, Delete & Update

Create Document Line

The “www.” subdomain prefix can included and excluded from the URL used for the API Request. Examples below:

https://www.aqilla.net/InstanceName/wsapi/2.5/Documents/Miscellaneous/Miscellaneous - Details/MISC000004/sub
https://aqilla.net/InstanceName/wsapi/2.5/Documents/Miscellaneous/Miscellaneous - Details/MISC000004/sub

Try excluding “www.” from the URL if your API request fails to pull data.

The following endpoint URL styles are used:

https://{server}/{instance name}/wsapi/2.5/Documents/{summary view}/{details view}/{UBK}/sub
e.g. https://www.aqilla.net/ InstanceName/wsapi/2.5/Documents/Miscellaneous/Miscellaneous - Details/MISC000004/sub
https://{server}/{instance name}/wsapi/2.5/{GUID}/sub
e.g. https://www.aqilla.net/ InstanceName/wsapi/2.5/8sggg986s6787g786sts33ds/sub

In API requests, the forward slash (/) primarily functions as a path separator to delineate the resource hierarchy. However, when a forward slash appears within a parameter's value, it can cause issues. To address this, the slash must be specially encoded.

For paths like "Purchase Invoice M/C," where the forward slash "/" is part of the name or text, it must be encoded to prevent the REST API from misinterpreting it as a path separator.

Instead of using "/", use "%252F".

Thus, "Purchase Invoice M/C" should be written as "Purchase Invoice M%252FC" in the API path.

Create document line - example

Header

XML

PUT https://www.aqilla.net/InstanceName/wsapi/2.5/Documents/Miscellaneous/Miscellaneous - Details/MISC000004/sub
Content-Type: application/xml

Header (Alternative using “%252F” instead of “/”)

XML

PUT https://www.aqilla.net/InstanceName/wsapi/2.5/Documents/Purchase Invoice M%252FC/Purchase Invoice M%252FC - Details/PI_001090/sub
Content-Type: application/xml

Body

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dataentry>
  <entities>
    <entity>
      <returnattribute name="Account"/>
      <returnattribute name="Description"/>
      <attribute name="Account">P1110</attribute>
      <attribute name="Description">Test Put Multiple Lines 1</attribute>
      <attribute name="Base">100</attribute>
      <attribute name="Cr/Db">Credit</attribute>
      <attribute name="Due Date">29 Sep 2016</attribute>
      <attribute name="Project">P001</attribute>
    </entity>
    <entity>
      <returnattribute name="Account"/>
      <returnattribute name="Description"/>
      <attribute name="Account">P1120</attribute>
      <attribute name="Description">Test Put Multiple Lines 2</attribute>
      <attribute name="Base">100</attribute>
      <attribute name="Cr/Db">Debit</attribute>
      <attribute name="Due Date">29 Sep 2016</attribute>
      <attribute name="Project">P001</attribute>
    </entity>
  </entities>
</dataentry>

Response

XML

200 OK

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dataentry>
    <entities>
        <entity sguid="xjOJkxDI9wrDVrackZwWgn1An4" id="3" sequence="3">
            <returnattribute name="Account">P1110(Direct Support &amp; Maintenance)</returnattribute>
            <returnattribute name="Description">Test Put Multiple Lines 1</returnattribute>
            <attachments/>
        </entity>
        <entity sguid="jWOnyzlHemZy3Zwslk9WmRZqr3" id="4" sequence="4">
            <returnattribute name="Account">P1120(Direct Consultancy)</returnattribute>
            <returnattribute name="Description">Test Put Multiple Lines 2</returnattribute>
            <attachments/>
        </entity>
    </entities>
</dataentry>

Document lines are created with the Aqilla state Entered. See Promote Document Line to learn how to promote documents.

Attach file to document line

See: Attachments

Delete Document Line

The following endpoint URL styles are used:

https://{server}/{instance name}/wsapi/2.5/Documents/{summary view}/{details view}/{doc ref}/sub/{line number}
e.g. https://www.aqilla.net/ InstanceName /wsapi/2.5/Documents/Miscellaneous/Miscellaneous - Details/MISC000004/sub/1
https://{server}/{instance name}/wsapi/2.5/{GUID}/sub
e.g. https://www.aqilla.net/ InstanceName /wsapi/2.5/8sggg986s6787g786sts33ds

The line number may not be obvious to you. If you enter two lines and delete them both the next line will be line 3. It's always safest to use GUID's.

Delete document line - example

API Request

XML

DELETE https://www.aqilla.net/InstanceName/wsapi/2.5/Documents/Miscellaneous/Miscellaneous - Details/MISC000004/sub/4

Response

XML

204 No Content

Document lines are created with the Aqilla state Entered. See Promote Document Line to learn how to promote documents.

Update Document line

The following endpoint URL styles are used:

https://{server}/{instance name}/wsapi/2.5/Documents/{summary view}/{details view}/{UBK}/sub/{line number}
e.g. https://www.aqilla.net/ InstanceName /wsapi/2.5/Documents/Miscellaneous/Miscellaneous - Details/MISC000004/sub/1
https://{server}/{instance name}/wsapi/2.5/{GUID}
e.g. https://www.aqilla.net/ InstanceName /wsapi/2.5/8sggg986s6787g786sts33ds

The line number may not be obvious to you. If you enter two lines and delete them both the next line will be line 3. It's always safest to use GUID's.

Update document line - example

API Request

XML

POST https://www.aqilla.net/InstanceName/wsapi/2.5/Documents/Miscellaneous/Miscellaneous - Details/MISC000007/sub/1
Content-Type: application/xml

Body

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dataentry>
  <entity>
    <returnattribute name="Account"/>
    <returnattribute name="Description"/>
    <returnattribute name="Base"/>
    <attribute name="Base">200</attribute>
  </entity>
</dataentry>

Response

XML

200 OK

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dataentry>
  <entity sguid="rRkqRByMukZ6me60IzdbdDvqLp" id="1" sequence="1">
    <returnattribute name="Account">P1100(Direct Sales)</returnattribute>
    <returnattribute name="Description">Test</returnattribute>
    <returnattribute name="Base">200.00</returnattribute>
    <attachments/>
  </entity>
</dataentry>