List Projects

readByQuery

<readByQuery>
    <object>PROJECT</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use PROJECT
fields Required string Comma separated list of fields on the object to list. Use * to return all fields.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Set a custom page size between 1 and 1000 items (Default: 100)

Get Project

read

<read>
    <object>PROJECT</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use PROJECT
keys Required string The project RECORDNO to get
fields Required string Comma separated list of fields on the object to get. Use * to return all fields.

Get Project by Name

readByName

<readByName>
    <object>PROJECT</object>
    <keys>P1234</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use PROJECT
keys Required string The project PROJECTID to get
fields Required string Comma separated list of fields on the object to get. Use * to return all fields.

Create Project

create

<create>
    <PROJECT>
        <NAME>hello world</NAME>
        <PROJECTCATEGORY>Contract</PROJECTCATEGORY>
    </PROJECT>
</create>

Parameters

Name Required Type Description
PROJECT Optional object The object to create

PROJECT

Name Required Type Description
PROJECTID Optional string The project ID to create. Required if company does not use auto-numbering.
NAME Required string Name
PROJECTCATEGORY Required string Project category
DESCRIPTION Optional string Description
PARENTID Optional string Parent project ID
INVOICEWITHPARENT Optional boolean Use false for No, true for Yes. (Default: false)
PROJECTTYPE Optional string Project type
PROJECTSTATUS Optional string Project status
CUSTOMERID Optional string Customer ID
MANAGERID Optional string Project manager employee ID
CUSTUSERID Optional string External user ID
SALESCONTACTID Optional string Sales contact employee ID
DOCNUMBER Optional string Reference number
USERRESTRICTIONS Optional string User restrictions
STATUS Optional string Status. Use active for Active otherwise use inactive for Inactive (Default: active)
CONTACTINFO Optional object Primary contact
BILLTO Optional object Bill to contact
SHIPTO Optional object Ship to contact
TERMNAME Optional string Payment term
BILLINGTYPE Optional string Billing type
BEGINDATE Optional string Begin date in format mm/dd/yyyy
ENDDATE Optional string End date in format mm/dd/yyyy
DEPARTMENTID Optional string Department ID
LOCATIONID Optional string Location ID
CLASSID Optional string Class ID
SUPDOCID Optional string Attachments ID
BILLABLEEXPDEFAULT Optional boolean Billable employee expense. Use false for No, true for Yes. (Default: false)
BILLABLEAPPODEFAULT Optional boolean Billable AP/purchasing. Use false for No, true for Yes. (Default: false)
OBSPERCENTCOMPLETE Optional decimal Observed percent complete
CURRENCY Optional string Currency code
SONUMBER Optional string Sales order number
PONUMBER Optional string Purchase order number
POAMOUNT Optional currency Purchase order amount
PQNUMBER Optional string Purchase quote number
CONTRACTAMOUNT Optional currency Contract amount
PROJECT_RULES Optional PROJECT_RULES[] Transaction rules for project. Multiple PROJECT_RULES elements may be passed.
BILLINGPRICING Optional string Labor pricing option
BILLINGRATE Optional number Labor pricing default rate
EXPENSEPRICING Optional string Expense pricing option
EXPENSERATE Optional number Expense pricing default rate
POAPPRICING Optional string AP/purchasing pricing option
POAPRATE Optional number AP/purchasing pricing default rate
BUDGETAMOUNT Optional currency Budgeted billing amount
BUDGETEDCOST Optional currency Budgeted cost
BUDGETQTY Optional number Budgeted duration
BUDGETID Optional string GL budget ID
INVOICEMESSAGE Optional string Invoice message
INVOICECURRENCY Optional string Invoice currency code
Custom fields Optional varies This object supports custom fields.

CONTACTINFO

Name Required Type Description
CONTACTNAME Required string Primary contact name

BILLTO

Name Required Type Description
CONTACTNAME Required string Bill to contact name

SHIPTO

Name Required Type Description
CONTACTNAME Required string Ship to contact name

PROJECT_RULES

Name Required Type Description
RULENAME Required string Transaction rule name

Update Project

update

<update>
    <PROJECT>
        <PROJECTID>P1234</PROJECTID>
        <NAME>hello world</NAME>
    </PROJECT>
</update>

Update a project with 2 transaction rules

<update>
    <PROJECT>
        <PROJECTID>P1234</PROJECTID>
        <PROJECT_RULES>
            <RULENAME>Test Rule</RULENAME>
        </PROJECT_RULES>
        <PROJECT_RULES>
            <RULENAME>Test Rule2</RULENAME>
        </PROJECT_RULES>
    </PROJECT>
</update>

Parameters

Name Required Type Description
PROJECT Optional object The object to update

PROJECT

Name Required Type Description
RECORDNO Optional integer Record number of project. Required if not using Project ID.
PROJECTID Optional string Project ID. Required if not using Record number.
NAME Optional string Name
PROJECTCATEGORY Optional string Project category
DESCRIPTION Optional string Description
PARENTID Optional string Parent project ID
INVOICEWITHPARENT Optional boolean Use false for No, true for Yes. (Default: false)
PROJECTTYPE Optional string Project type
PROJECTSTATUS Optional string Project status
CUSTOMERID Optional string Customer ID
MANAGERID Optional string Project manager employee ID
CUSTUSERID Optional string External user ID
SALESCONTACTID Optional string Sales contact employee ID
DOCNUMBER Optional string Reference number
USERRESTRICTIONS Optional string User restrictions
STATUS Optional string Status. Use active for Active otherwise use inactive for Inactive (Default: active)
CONTACTINFO Optional object Primary contact
BILLTO Optional object Bill to contact
SHIPTO Optional object Ship to contact
TERMNAME Optional string Payment term
BILLINGTYPE Optional string Billing type
BEGINDATE Optional string Begin date in format mm/dd/yyyy
ENDDATE Optional string End date in format mm/dd/yyyy
DEPARTMENTID Optional string Department ID
LOCATIONID Optional string Location ID
CLASSID Optional string Class ID
SUPDOCID Optional string Attachments ID
BILLABLEEXPDEFAULT Optional boolean Billable employee expense. Use false for No, true for Yes. (Default: false)
BILLABLEAPPODEFAULT Optional boolean Billable AP/purchasing. Use false for No, true for Yes. (Default: false)
OBSPERCENTCOMPLETE Optional decimal Observed percent complete
CURRENCY Optional string Currency code
SONUMBER Optional string Sales order number
PONUMBER Optional string Purchase order number
POAMOUNT Optional currency Purchase order amount
PQNUMBER Optional string Purchase quote number
CONTRACTAMOUNT Optional currency Contract amount
PROJECT_RULES Optional PROJECT_RULES[] Transaction rules for project. Multiple PROJECT_RULES elements may be passed. This is a complete replace, so you must pass all existing rules you want to keep.
BILLINGPRICING Optional string Labor pricing option
BILLINGRATE Optional number Labor pricing default rate
EXPENSEPRICING Optional string Expense pricing option
EXPENSERATE Optional number Expense pricing default rate
POAPPRICING Optional string AP/purchasing pricing option
POAPRATE Optional number AP/purchasing pricing default rate
BUDGETAMOUNT Optional currency Budgeted billing amount
BUDGETEDCOST Optional currency Budgeted cost
BUDGETQTY Optional number Budgeted duration
BUDGETID Optional string GL budget ID
INVOICEMESSAGE Optional string Invoice message
INVOICECURRENCY Optional string Invoice currency code
Custom fields Optional varies This object supports custom fields.

CONTACTINFO

Name Required Type Description
CONTACTNAME Required string Primary contact name

BILLTO

Name Required Type Description
CONTACTNAME Required string Bill to contact name

SHIPTO

Name Required Type Description
CONTACTNAME Required string Ship to contact name

PROJECT_RULES

Name Required Type Description
RULENAME Required string Transaction rule name

Delete Project

delete

<delete>
    <object>PROJECT</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use PROJECT
keys Required string The project RECORDNO to delete

Provide feedback