Project contract billing invoice details

Project contract billing invoice details hold billing details for a single project contract line.

List project contract billing invoice details

get/objects/construction/project-contract-billing-invoice-detail

Returns up to 100 object references from the collection with a key, ID, and link for each project contract billing invoice detail. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "3480",
      • "id": "3480",
      • "href": "/objects/construction/project-contract-billing-invoice-detail/3480"
      },
    • {
      • "key": "3483",
      • "id": "3483",
      • "href": "/objects/construction/project-contract-billing-invoice-detail/3483"
      },
    • {
      • "key": "3758",
      • "id": "3758",
      • "href": "/objects/construction/project-contract-billing-invoice-detail/3758"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a project contract billing invoice detail
get/objects/construction/project-contract-billing-invoice-detail/{key}
Returns detailed information for a specified project contract billing invoice detail.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the project contract billing invoice detail.


 
 Example:  3760
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "3760",
    • "key": "3760",
    • "orderEntryDocument": {
      • "key": "5143",
      • "documentNumber": "Ord#0189#doc",
      • "href": "/objects/order-entry/document/5143"
      },
    • "accountsReceivableInvoice": {
      • "id": "1913",
      • "key": "1913",
      • "href": "/objects/accounts-receivable/invoice/1913"
      },
    • "projectContractBillingInvoiceSummary": {
      • "id": "313",
      • "key": "313",
      • "href": "/objects/construction/project-contract-billing-invoice-summary/313"
      },
    • "projectContract": {
      • "key": "38",
      • "id": "PC 08 Jun",
      • "name": "PC 08 Jun",
      • "href": "/objects/construction/project-contract/38"
      },
    • "projectContractLine": {
      • "key": "1568",
      • "id": "L1",
      • "name": "L1",
      • "description": "PC08-L1",
      • "isBillable": true,
      • "href": "/objects/construction/project-contract-line/1568"
      },
    • "externalReferenceNumber": "DIM-JHC-EX-8098",
    • "internalReferenceNumber": "DIM-JHC-IN-6924",
    • "project": {
      • "key": "3",
      • "id": "DIM - JHC",
      • "name": "Dimensions - Jones Hogan Company",
      • "href": "/objects/projects/project/3"
      },
    • "task": {
      • "key": "153",
      • "id": "CS Services",
      • "name": "Customer Support Services",
      • "href": "/objects/projects/task/153"
      },
    • "billingTotals": {
      • "originalContractAmount": "150.0000000000",
      • "changesApprovedPriorMonths": {
        },
      • "changesApprovedThisMonth": {
        },
      • "netApprovedChangesAmount": "150.0000000000",
      • "revisedContractAmount": "300.0000000000",
      • "completedFromPriorApplicationAmount": "177.0000000000",
      • "completedThisPeriodAmount": "11.0000000000",
      • "storedMaterialsAmount": "12.0000000000",
      • "completedToDateAmount": "200.0000000000",
      • "completedToDatePercent": "66.6700000000",
      • "retainage": {
        },
      • "billedAmount": "23.0000000000",
      • "taxAmount": "0.0000000000",
      • "chargeAmount": "0.0000000000",
      • "discountAmount": "0.0000000000",
      • "balanceToFinishAmount": "123.8500000000",
      • "currentDueAmount": "22.4700000000"
      },
    • "entity": {
      • "key": "1",
      • "name": "1",
      • "id": "1",
      • "href": "/objects/company-config/entity/1"
      },
    • "href": "/objects/construction/project-contract-billing-invoice-detail/3760"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query project contract billing invoice details
post/services/core/query
Use the query service to find project contract billing invoice details that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Feedback