API - Project Manage / Add Item


Resource:
/acumulus/stable/projects/projectitem_manage.php
Since API:
Available for authenticated:
API gebruiker
Available for authenticated:
API beheerder
Communication:
Basic submit, including below structure

Submit

<?xml version="1.0" encoding="UTF-8"?>
<myxml>
    ...
    <projectitem>
        <projectid></projectid>
        <projectitemid></projectitemid>
        <projectitemnatureid></projectitemnatureid>
        <projectitemname></projectitemname>
        <projectitemstartdate></projectitemstartdate>
        <projectitemenddate></projectitemenddate>
        <projectitemprice></projectitemprice>
        <projectitemminutes></projectitemminutes>
        <projectitemquantity></projectitemquantity>
        <projectitemvatrate></projectitemvatrate>
        <projectitemnotes></projectitemnotes>
        <projectitemstatusid></projectitemstatusid>
        <projectitementryid></projectitementryid>
        <projectitemdelete></projectitemdelete>
    </projectitem>
</myxml>

projectid mandatory
Unique numeric identifier for project.


projectitemid mandatory / non mandatory
Unique numeric identifier for project item. Leave empty when adding a new projectitem to a project or include when updating or deleting a current project item.


projectitemnatureid
Numeric identifier for the nature or type of item.

Option
Description
Remark
1
Product
2
Service at an hourly rate
DEFAULT
3
Service at a fixed price

projectitemname
Descriptive name for the item within the project.


projectitemstartdate
Start date of the item. Mainly useful with billable services or for tracking applied effort. Use YYYY-MM-DD format. Defaults to current date.


projectitemenddate
End date of the item. Mainly useful with billable services or for tracking applied effort. Use YYYY-MM-DD format. Defaults to current date.


projectitemprice
Price of the item. Up to 4 decimals. Defaults to 0.0000


projectitemminutes
Amount of minutes. Defaults to 0.


projectitemquantity
Amount of items. Up to 2 decimals. Defaults to 0.00


projectitemvatrate
Applicable VAT percentage for the project item. Within range of 0 to 100. Use -1 when VAT is not applicable. Up to 2 decimals. Defaults to 21.


projectitemnotes
Internal notes applicable to the item.


projectitemstatusid
Numeric identifier for the status of the item.

Option
Description
Remark
1
Planned
DEFAULT
2
Completed
3
Cancelled
4
Active
5
Expense
(label)
6
Non billable

projectitementryid
Reference an entryid associated with an already available invoice allowing to mark the item as billed. Please note that this is only a mark and not a trigger in any way.


projectitemforeignvat
Numeric value to indicate if foreign vat is applicable.

Option
Description
Remark
0
Dutch VAT
DEFAULT
1
Foreign (EU) VAT

projectitemupdateconcepts
Numeric value to indicate if concept-invoices which include the projectitem should be updated.

Option
Description
Remark
0
Leave concept-invoices as is.
DEFAULT
1
Update concept-invoices with provided projectitem details

projectitemdelete
Numeric value to indicate deletion of the project item.

Option
Description
Remark
0
Do not delete item
DEFAULT
1
Delete item

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    ...
    <projectitem>
        <projectid> 
        <projectitemid></projectitemid>
        <projectitemproc></projectitemproc>
        <projectitemname></projectitemname>
        <projectitemstartdate></projectitemstartdate
        <projectitemenddate></projectitemenddate>
        <projectitemnatureid></projectitemnatureid>
        <projectitemforeignvat></projectitemforeignvat
        <projectitemupdateconcepts></projectitemupdateconcepts>
        <projectitemprice></projectitemprice>
        <projectitemquantity></projectitemquantity>
        <projectitemminutes></projectitemminutes>
        <projectitemvatrate></projectitemvatrate>
        <projectitementryid></projectitementryid>
        <projectitemstatusid></projectitemstatusid>
        <projectitemnotes></projectitemnotes>
    </projectitem>
</response>

projectitemproc
Type of action executed. Should be updated, added or deleted.