GET api/Project/DocId/{docId}

Get Project by Document ID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
docId

Project Document ID

 integer

Required

Body Parameters

None.

Response Information

Resource Description

Project

Project
NameDescriptionTypeAdditional information
ProjectID

Project ID

integer

None.
ProjectGuid

Project Guid

globally unique identifier

None.
ClientId

Client Id

integer

None.
CompanyId

Company Id

integer

None.
CompanyCode

Company Code

string

None.
CompanyLocationId

Company Location Id

integer

None.
LocationCode

Location Code

string

None.
ProjectNumber

Project Number

string

None.
ProjectTypeId

Project Type ID

integer

None.
ProjectType

Project Type

string

None.
ProjectName

Project Name

string

None.
AmountRequested

Amount Requested

decimal number

None.
AmountApproved

Amount Approved

decimal number

None.
AmountExpended

Amount Expended

decimal number

None.
AmountAvailable

Amount Available

decimal number

None.
Reason

Reason

string

None.
StartDate

Start Date

date

None.
EstimatedEndDate

Estimated End Date

date

None.
ActualEndDate

Actual End Date

date

None.
CloseDate

Close Date

date

None.
CreateDate

Create Date

date

None.
CreatedByName

Created By Name

string

None.
RequestedByName

Requested by Name

string

None.
ProjectPriority

Project Priority

string

None.
ProjectPriorityId

Project Priority ID

integer

None.
TaxAllocationYN

Tax allocation flag

boolean

None.
GLCode

GL Code

string

None.
ExportDate

Export Date

date

None.
BudgetCode

Budget Code

string

None.
Lines

Project Lines

Collection of ProjectLine

None.
PurchaseOrders

Linked purchase orders

Collection of LinkedPurchaseOrder

None.
Invoices

Linked invoices

Collection of ProjectLinkedInvoice

None.

Response Formats

application/json, text/json

Sample: 
{
  "ProjectID": 1,
  "ProjectGuid": "5e082873-f7eb-4a88-8920-6a55fa984fa0",
  "ClientId": 1,
  "CompanyId": 1,
  "CompanyCode": "sample string 2",
  "CompanyLocationId": 1,
  "LocationCode": "sample string 3",
  "ProjectNumber": "sample string 4",
  "ProjectTypeId": 1,
  "ProjectType": "sample string 5",
  "ProjectName": "sample string 6",
  "AmountRequested": 7.0,
  "AmountApproved": 8.0,
  "AmountExpended": 9.0,
  "AmountAvailable": 10.0,
  "Reason": "sample string 11",
  "StartDate": "2026-09-21T02:44:56.9191846-05:00",
  "EstimatedEndDate": "2026-09-21T02:44:56.9191846-05:00",
  "ActualEndDate": "2026-09-21T02:44:56.9191846-05:00",
  "CloseDate": "2026-09-21T02:44:56.9191846-05:00",
  "CreateDate": "2026-09-21T02:44:56.9191846-05:00",
  "CreatedByName": "sample string 17",
  "RequestedByName": "sample string 18",
  "ProjectPriority": "sample string 19",
  "ProjectPriorityId": 1,
  "TaxAllocationYN": true,
  "GLCode": "sample string 21",
  "ExportDate": "2026-09-21T02:44:56.9191846-05:00",
  "BudgetCode": "sample string 23",
  "Lines": [
    {
      "ProjectLineId": 1,
      "ProjectLineCategoryId": 1,
      "ProjectLineCategory": "sample string 1",
      "Description": "sample string 2",
      "Amount": 3.0,
      "Year": 1,
      "Period": 1,
      "DepartmentId": 1,
      "Department": "sample string 4",
      "AssetClassId": 1,
      "AssetClass": "sample string 5",
      "ExpenseClassId": 1,
      "ExpenseClass": "sample string 6",
      "ExportDate": "2026-09-21T02:44:56.9191846-05:00",
      "UserText1": "sample string 8",
      "UserText2": "sample string 9",
      "UserText3": "sample string 10",
      "UserText4": "sample string 11",
      "UserText5": "sample string 12",
      "UserText6": "sample string 13",
      "UserText7": "sample string 14",
      "UserText8": "sample string 15",
      "UserText9": "sample string 16",
      "UserText10": "sample string 17",
      "CreateDate": "2026-09-21T02:44:56.9191846-05:00",
      "LineNumber": "sample string 19",
      "CreatedByName": "sample string 20",
      "ProjectLineSubCategory": "sample string 21",
      "ProjectLineSubCategoryId": 1,
      "LocationId": 1,
      "LocationCode": "sample string 22",
      "ApprovedAmount": 23.0,
      "LineDetails": [
        {
          "ProjectLineDetailId": 1,
          "ProjectLineCategoryId": 1,
          "ProjectLineCategory": "sample string 1",
          "Description": "sample string 2",
          "Amount": 3.0
        },
        {
          "ProjectLineDetailId": 1,
          "ProjectLineCategoryId": 1,
          "ProjectLineCategory": "sample string 1",
          "Description": "sample string 2",
          "Amount": 3.0
        }
      ]
    },
    {
      "ProjectLineId": 1,
      "ProjectLineCategoryId": 1,
      "ProjectLineCategory": "sample string 1",
      "Description": "sample string 2",
      "Amount": 3.0,
      "Year": 1,
      "Period": 1,
      "DepartmentId": 1,
      "Department": "sample string 4",
      "AssetClassId": 1,
      "AssetClass": "sample string 5",
      "ExpenseClassId": 1,
      "ExpenseClass": "sample string 6",
      "ExportDate": "2026-09-21T02:44:56.9191846-05:00",
      "UserText1": "sample string 8",
      "UserText2": "sample string 9",
      "UserText3": "sample string 10",
      "UserText4": "sample string 11",
      "UserText5": "sample string 12",
      "UserText6": "sample string 13",
      "UserText7": "sample string 14",
      "UserText8": "sample string 15",
      "UserText9": "sample string 16",
      "UserText10": "sample string 17",
      "CreateDate": "2026-09-21T02:44:56.9191846-05:00",
      "LineNumber": "sample string 19",
      "CreatedByName": "sample string 20",
      "ProjectLineSubCategory": "sample string 21",
      "ProjectLineSubCategoryId": 1,
      "LocationId": 1,
      "LocationCode": "sample string 22",
      "ApprovedAmount": 23.0,
      "LineDetails": [
        {
          "ProjectLineDetailId": 1,
          "ProjectLineCategoryId": 1,
          "ProjectLineCategory": "sample string 1",
          "Description": "sample string 2",
          "Amount": 3.0
        },
        {
          "ProjectLineDetailId": 1,
          "ProjectLineCategoryId": 1,
          "ProjectLineCategory": "sample string 1",
          "Description": "sample string 2",
          "Amount": 3.0
        }
      ]
    }
  ],
  "PurchaseOrders": [
    {
      "DocumentID": 1,
      "PurchaseOrderNumber": "sample string 2",
      "Status": "sample string 3",
      "PurchaseOrderDate": "2026-09-21T02:44:56.9191846-05:00",
      "VendorName": "sample string 5",
      "TotalAmount": 6.0
    },
    {
      "DocumentID": 1,
      "PurchaseOrderNumber": "sample string 2",
      "Status": "sample string 3",
      "PurchaseOrderDate": "2026-09-21T02:44:56.9191846-05:00",
      "VendorName": "sample string 5",
      "TotalAmount": 6.0
    }
  ],
  "Invoices": [
    {
      "DocumentID": 1,
      "InvoiceNumber": "sample string 2",
      "PurchaseOrderNumber": "sample string 3",
      "InvoiceTotal": 1.0,
      "Status": "sample string 4",
      "InvoiceDate": "2026-09-21T02:44:56.9191846-05:00",
      "VendorCode": "sample string 5",
      "VendorName": "sample string 6"
    },
    {
      "DocumentID": 1,
      "InvoiceNumber": "sample string 2",
      "PurchaseOrderNumber": "sample string 3",
      "InvoiceTotal": 1.0,
      "Status": "sample string 4",
      "InvoiceDate": "2026-09-21T02:44:56.9191846-05:00",
      "VendorCode": "sample string 5",
      "VendorName": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample: 
<ProjectController.Project xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers">
  <ActualEndDate>2026-09-21T02:44:56.9191846-05:00</ActualEndDate>
  <AmountApproved>8</AmountApproved>
  <AmountAvailable>10</AmountAvailable>
  <AmountExpended>9</AmountExpended>
  <AmountRequested>7</AmountRequested>
  <BudgetCode>sample string 23</BudgetCode>
  <ClientId>1</ClientId>
  <CloseDate>2026-09-21T02:44:56.9191846-05:00</CloseDate>
  <CompanyCode>sample string 2</CompanyCode>
  <CompanyId>1</CompanyId>
  <CompanyLocationId>1</CompanyLocationId>
  <CreateDate>2026-09-21T02:44:56.9191846-05:00</CreateDate>
  <CreatedByName>sample string 17</CreatedByName>
  <EstimatedEndDate>2026-09-21T02:44:56.9191846-05:00</EstimatedEndDate>
  <ExportDate>2026-09-21T02:44:56.9191846-05:00</ExportDate>
  <GLCode>sample string 21</GLCode>
  <Invoices>
    <ProjectController.ProjectLinkedInvoice>
      <DocumentID>1</DocumentID>
      <InvoiceDate>2026-09-21T02:44:56.9191846-05:00</InvoiceDate>
      <InvoiceNumber>sample string 2</InvoiceNumber>
      <InvoiceTotal>1</InvoiceTotal>
      <PurchaseOrderNumber>sample string 3</PurchaseOrderNumber>
      <Status>sample string 4</Status>
      <VendorCode>sample string 5</VendorCode>
      <VendorName>sample string 6</VendorName>
    </ProjectController.ProjectLinkedInvoice>
    <ProjectController.ProjectLinkedInvoice>
      <DocumentID>1</DocumentID>
      <InvoiceDate>2026-09-21T02:44:56.9191846-05:00</InvoiceDate>
      <InvoiceNumber>sample string 2</InvoiceNumber>
      <InvoiceTotal>1</InvoiceTotal>
      <PurchaseOrderNumber>sample string 3</PurchaseOrderNumber>
      <Status>sample string 4</Status>
      <VendorCode>sample string 5</VendorCode>
      <VendorName>sample string 6</VendorName>
    </ProjectController.ProjectLinkedInvoice>
  </Invoices>
  <Lines>
    <ProjectController.ProjectLine>
      <Amount>3</Amount>
      <ApprovedAmount>23</ApprovedAmount>
      <AssetClass>sample string 5</AssetClass>
      <AssetClassId>1</AssetClassId>
      <CreateDate>2026-09-21T02:44:56.9191846-05:00</CreateDate>
      <CreatedByName>sample string 20</CreatedByName>
      <Department>sample string 4</Department>
      <DepartmentId>1</DepartmentId>
      <Description>sample string 2</Description>
      <ExpenseClass>sample string 6</ExpenseClass>
      <ExpenseClassId>1</ExpenseClassId>
      <ExportDate>2026-09-21T02:44:56.9191846-05:00</ExportDate>
      <LineDetails>
        <ProjectController.LineDetail>
          <Amount>3</Amount>
          <Description>sample string 2</Description>
          <ProjectLineCategory>sample string 1</ProjectLineCategory>
          <ProjectLineCategoryId>1</ProjectLineCategoryId>
          <ProjectLineDetailId>1</ProjectLineDetailId>
        </ProjectController.LineDetail>
        <ProjectController.LineDetail>
          <Amount>3</Amount>
          <Description>sample string 2</Description>
          <ProjectLineCategory>sample string 1</ProjectLineCategory>
          <ProjectLineCategoryId>1</ProjectLineCategoryId>
          <ProjectLineDetailId>1</ProjectLineDetailId>
        </ProjectController.LineDetail>
      </LineDetails>
      <LineNumber>sample string 19</LineNumber>
      <LocationCode>sample string 22</LocationCode>
      <LocationId>1</LocationId>
      <Period>1</Period>
      <ProjectLineCategory>sample string 1</ProjectLineCategory>
      <ProjectLineCategoryId>1</ProjectLineCategoryId>
      <ProjectLineId>1</ProjectLineId>
      <ProjectLineSubCategory>sample string 21</ProjectLineSubCategory>
      <ProjectLineSubCategoryId>1</ProjectLineSubCategoryId>
      <UserText1>sample string 8</UserText1>
      <UserText10>sample string 17</UserText10>
      <UserText2>sample string 9</UserText2>
      <UserText3>sample string 10</UserText3>
      <UserText4>sample string 11</UserText4>
      <UserText5>sample string 12</UserText5>
      <UserText6>sample string 13</UserText6>
      <UserText7>sample string 14</UserText7>
      <UserText8>sample string 15</UserText8>
      <UserText9>sample string 16</UserText9>
      <Year>1</Year>
    </ProjectController.ProjectLine>
    <ProjectController.ProjectLine>
      <Amount>3</Amount>
      <ApprovedAmount>23</ApprovedAmount>
      <AssetClass>sample string 5</AssetClass>
      <AssetClassId>1</AssetClassId>
      <CreateDate>2026-09-21T02:44:56.9191846-05:00</CreateDate>
      <CreatedByName>sample string 20</CreatedByName>
      <Department>sample string 4</Department>
      <DepartmentId>1</DepartmentId>
      <Description>sample string 2</Description>
      <ExpenseClass>sample string 6</ExpenseClass>
      <ExpenseClassId>1</ExpenseClassId>
      <ExportDate>2026-09-21T02:44:56.9191846-05:00</ExportDate>
      <LineDetails>
        <ProjectController.LineDetail>
          <Amount>3</Amount>
          <Description>sample string 2</Description>
          <ProjectLineCategory>sample string 1</ProjectLineCategory>
          <ProjectLineCategoryId>1</ProjectLineCategoryId>
          <ProjectLineDetailId>1</ProjectLineDetailId>
        </ProjectController.LineDetail>
        <ProjectController.LineDetail>
          <Amount>3</Amount>
          <Description>sample string 2</Description>
          <ProjectLineCategory>sample string 1</ProjectLineCategory>
          <ProjectLineCategoryId>1</ProjectLineCategoryId>
          <ProjectLineDetailId>1</ProjectLineDetailId>
        </ProjectController.LineDetail>
      </LineDetails>
      <LineNumber>sample string 19</LineNumber>
      <LocationCode>sample string 22</LocationCode>
      <LocationId>1</LocationId>
      <Period>1</Period>
      <ProjectLineCategory>sample string 1</ProjectLineCategory>
      <ProjectLineCategoryId>1</ProjectLineCategoryId>
      <ProjectLineId>1</ProjectLineId>
      <ProjectLineSubCategory>sample string 21</ProjectLineSubCategory>
      <ProjectLineSubCategoryId>1</ProjectLineSubCategoryId>
      <UserText1>sample string 8</UserText1>
      <UserText10>sample string 17</UserText10>
      <UserText2>sample string 9</UserText2>
      <UserText3>sample string 10</UserText3>
      <UserText4>sample string 11</UserText4>
      <UserText5>sample string 12</UserText5>
      <UserText6>sample string 13</UserText6>
      <UserText7>sample string 14</UserText7>
      <UserText8>sample string 15</UserText8>
      <UserText9>sample string 16</UserText9>
      <Year>1</Year>
    </ProjectController.ProjectLine>
  </Lines>
  <LocationCode>sample string 3</LocationCode>
  <ProjectGuid>5e082873-f7eb-4a88-8920-6a55fa984fa0</ProjectGuid>
  <ProjectID>1</ProjectID>
  <ProjectName>sample string 6</ProjectName>
  <ProjectNumber>sample string 4</ProjectNumber>
  <ProjectPriority>sample string 19</ProjectPriority>
  <ProjectPriorityId>1</ProjectPriorityId>
  <ProjectType>sample string 5</ProjectType>
  <ProjectTypeId>1</ProjectTypeId>
  <PurchaseOrders>
    <ProjectController.LinkedPurchaseOrder>
      <DocumentID>1</DocumentID>
      <PurchaseOrderDate>2026-09-21T02:44:56.9191846-05:00</PurchaseOrderDate>
      <PurchaseOrderNumber>sample string 2</PurchaseOrderNumber>
      <Status>sample string 3</Status>
      <TotalAmount>6</TotalAmount>
      <VendorName>sample string 5</VendorName>
    </ProjectController.LinkedPurchaseOrder>
    <ProjectController.LinkedPurchaseOrder>
      <DocumentID>1</DocumentID>
      <PurchaseOrderDate>2026-09-21T02:44:56.9191846-05:00</PurchaseOrderDate>
      <PurchaseOrderNumber>sample string 2</PurchaseOrderNumber>
      <Status>sample string 3</Status>
      <TotalAmount>6</TotalAmount>
      <VendorName>sample string 5</VendorName>
    </ProjectController.LinkedPurchaseOrder>
  </PurchaseOrders>
  <Reason>sample string 11</Reason>
  <RequestedByName>sample string 18</RequestedByName>
  <StartDate>2026-09-21T02:44:56.9191846-05:00</StartDate>
  <TaxAllocationYN>true</TaxAllocationYN>
</ProjectController.Project>