Project contract billing invoice summaries

Project contract billing invoice summaries enable a construction company to properly report on project contract billing totals, and are instrumental in creating industry-standard invoice templates. The fields in these objects contain the detail of the contract value, the amount that has been billed, is left to bill and the retainage held and billed during the contract duration.

List Project contract billing invoice summaries

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

Returns up to 100 object references from the collection with a key, ID, and link for each project contract billing invoice summary. 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": "310",
      • "id": "310",
      • "href": "/objects/construction/project-contract-billing-invoice-summary/310"
      },
    • {
      • "key": "311",
      • "id": "311",
      • "href": "/objects/construction/project-contract-billing-invoice-summary/311"
      },
    • {
      • "key": "313",
      • "id": "313",
      • "href": "/objects/construction/project-contract-billing-invoice-summary/313"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a Project contract billing invoice Summary
get/objects/construction/project-contract-billing-invoice-summary/{key}
Returns detailed information for a specified project contract billing invoice summary.


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


 
 Example:  313
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "313",
    • "key": "313",
    • "orderEntryDocument": {
      • "key": "5143",
      • "id": "SO-AIA-Invoice01-Ord#0189#doc",
      • "documentNumber": "Ord#0189#doc",
      • "href": "/objects/order-entry/document/5143"
      },
    • "accountsReceivableInvoice": {
      • "key": "23",
      • "id": "23",
      • "number": "INV1",
      • "href": "/objects/accounts-receivable/invoice/23"
      },
    • "projectContract": {
      • "key": "38",
      • "id": "PC 08 Jun",
      • "name": "PC 08 Jun",
      • "href": "/objects/construction/project-contract/38"
      },
    • "billingTotals": {
      • "originalContractAmount": "150.0000000000",
      • "changesApprovedPriorMonths": {
        },
      • "changesApprovedThisMonth": {
        },
      • "netApprovedChangesAmount": "150.0000000000",
      • "revisedContractAmount": "300.0000000000",
      • "completedFromPriorApplicationAmount": "177.0000000000",
      • "completedToDateAmount": "200.0000000000",
      • "retainage": {
        },
      • "lessPreviousBillingAmount": "155.6800000000",
      • "currentDueAmount": "20.4700000000",
      • "balanceToFinishAmount": "123.8500000000",
      • "taxAmount": "0.0000000000",
      • "discountAmount": "0.0000000000",
      • "chargeAmount": "0.0000000000"
      },
    • "billingThroughDate": "2024-05-29",
    • "billingApplicationNumber": "4",
    • "entity": {
      • "key": "1",
      • "name": "1",
      • "id": "1",
      • "href": "/objects/company-config/entity/1"
      },
    • "project": {
      • "key": "1",
      • "id": "DIM - HCS",
      • "name": "Dimensions - Hands Computer Systems",
      • "href": "/objects/projects/project/1"
      },
    • "href": "/objects/construction/project-contract-billing-invoice-summary/313"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query project contract billing invoice summaries
post/services/core/query
Use the query service to find project contract billing invoice summaries 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
    }
}