Logo
Submit a request
Follow

Contracts

Retrieving a Single Contract

URL

https://app.bluefolder.com/api/2.0/contracts/get.aspx

Request

<request>
    <contractId>xxxxxx</contractId>
</request>
            

Response

<response status="ok">
    <contract>
        <allowOverage></allowOverage>
        <balanceHours></balanceHours>
        <balanceMoney></balanceMoney>
        <billedToDateAmount></billedToDateAmount>
        <billedToDateHours></billedToDateHours>
        <billToAddressId></billToAddressId>
        <billToAddressName></billToAddressName>
        <billToCity></billToCity>
        <billToCountry></billToCountry>
        <billToId></billToId>
        <billToName></billToName>
        <billToPostalCode></billToPostalCode>
        <billToState></billToState>
        <billToStreetAddress></billToStreetAddress>
        <billToType></billToType>
        <contractDateEnd></contractDateEnd>
        <contractDateStart></contractDateStart>
        <contractDescription></contractDescription>
        <contractId></contractId>
        <contractLimitAmount></contractLimitAmount>
        <contractLimitHourlyRate></contractLimitHourlyRate>
        <contractLimitHours></contractLimitHours>
        <contractLimitType></contractLimitType>
        <contractName></contractName>
        <contractNotes></contractNotes>
        <contractNumber></contractNumber>
        <contractStatus></contractStatus>
        <contractTerms></contractTerms>
        <contractType></contractType>
        <createdByUserId></createdByUserId>
        <customerContactId></customerContactId>
        <customerId></customerId>
        <dateTimeCreated></dateTimeCreated>
        <hideFromPortal></hideFromPortal>
        <purchaseOrderNo></purchaseOrderNo>
        <subTotal></subTotal>
        <taxCodeId></taxCodeId>
        <taxRate></taxRate>
        <totalPrice></totalPrice>
    </contract>
</response>
            

Retrieving a List of Contracts

URL

https://app.bluefolder.com/api/2.0/contracts/list.aspx

Request

<request>
    <contractList>
        <listType>basic</listType>
        <customerId>a customer.Id to filter by</customerId>
        <customerName exactMatch="true|false">a customer name to filter by</customerName>
        <status>a status value to filter by</status>
    </contractList>
</request>
            
  • listType - string, either 'basic' or 'full'
  • customerId - string, filters the list by customerId
  • customerName - string, filters the list by the 'Customer Name'
  • status - string, filters the list by 'Status'

Response (for 'basic' list)

<response status="ok">
    <contractList>
        <contract>
            <contractId></contractId>
            <contractName></contractName>
            <contractStatus></contractStatus>
            <customerId></customerId>
            <customerName></customerName>
            <customerContactId></customerContactId>
            <contractDateEnd></contractDateEnd>
            <contractDateStart></contractDateStart>
            <contractNumber></contractNumber>
            <contractType></contractType>
            <dateTimeCreated></dateTimeCreated>
            <purchaseOrderNo></purchaseOrderNo>
            <totalPrice></totalPrice>
        </contract>
        <contract>
            ...
        </contract>
    </contractList>
</response>
            
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request