API

Sales APIs

GET sales/project-orders/{projectOrderId}/billable-sales

Project order's billable sales

HTTP method GET
URI https://api.rambase.net/sales/project-orders/{projectOrderId}/billable-sales
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {projectOrderId} Project order identifier
Integer, minimum 100000
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 4938, version 17

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

CINCCNCreated() Named filter Billing basis where there is created sales invoice or sales credit note, but this is not yet registered
CINCCNRegistered() Named filter Billing basis where there is created sales invoice or sales credit note, and this has been registered
MainLevel() Named filter Billing basis created only for the main level (for POD with pricing model "Fixed price")
ReadyToBeInvoiced() Named filter Billing basis that is ready to be invoiced
BillableSaleId Integer The billing basis sequence number.
BillingItemId Integer Item-number of the object.
BillingItemObjectId Integer Refers to the identifier of the CIN (sales invoice) or CCN (sales credit note) where this billing basis is invoiced/credited.
BillingItemObjectType String Refers to either CIN ( sales invoice ) or CCN (sales creditnote ) where this billingbasis is invoiced/credited.
Category String The category of this project order item: Material, Hours or Expenses.
IncurredCostDate Date The date the revenues became incurred. E.g the date a worker logs hours for (WOL.EndDate). Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
IsForwarded Boolean Determines whether CIN (sales invoice) has been forwarded to CCN (sales credit note).
Note String A note that will be copied to note in sales invoice item.
ProjectOrderItemId Integer Project order item identifier.
Quantity Decimal The quantity that will be invoiced; consumed quantity for material, billable hours from work log and "1" for expenses.
SourceObjectId Integer Identifier of the object.
SourceObjectItemId Integer Reference to the item id of the object.
SourceObjectType String The object type name for the archive.
Status Integer Status of billing basis.
Type String Type of object.

Read more about filters and sorting on how to use sortable parameters

BillableSaleId Integer The billing basis sequence number
BillingItemId Integer Item-number of the object
BillingItemObjectId Integer Refers to the identifier of the CIN (sales invoice) or CCN (sales credit note) where this billing basis is invoiced/credited
BillingItemObjectType String Refers to either CIN ( sales invoice ) or CCN (sales creditnote ) where this billingbasis is invoiced/credited
Category String The category of this project order item: Material, Hours or Expenses
IncurredCostDate Date The date the revenues became incurred. E.g the date a worker logs hours for (WOL.EndDate)
IsForwarded Boolean Determines whether CIN (sales invoice) has been forwarded to CCN (sales credit note)
Note String A note that will be copied to note in sales invoice item
ProjectOrderItemId Integer Project order item identifier
Quantity Decimal The quantity that will be invoiced; consumed quantity for material, billable hours from work log and "1" for expenses
SourceObjectId Integer Identifier of the object
SourceObjectItemId Integer Reference to the item id of the object
SourceObjectType String The object type name for the archive
Status Integer Status of billing basis
Type String Type of object

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<BillableSales>
2
     <BillableSale>
3
          <BillableSaleId
BillableSaleId

The billing basis sequence number

>{Integer}</BillableSaleId>
4
          <Status
Status

Status of billing basis

Possible domain values can be found here

>{Integer}</Status>
5
          <Type
Type

The object type name for the archive

>{String}</Type>
6
          <IsForwarded
IsForwarded

Determines whether CIN (sales invoice) has been forwarded to CCN (sales credit note)

>{Boolean}</IsForwarded>
7
          <IncurredCostDate
IncurredCostDate

The date the revenues became incurred. E.g the date a worker logs hours for (WOL.EndDate)

>{Date}</IncurredCostDate>
8
          <Quantity
Quantity

The quantity that will be invoiced; consumed quantity for material, billable hours from work log and "1" for expenses

>{Decimal}</Quantity>
9
          <Note
Note

A note that will be copied to note in sales invoice item

>{String}</Note>
10
          <ProjectOrderItem>
11
               <ProjectOrderItemId
ProjectOrderItemId

Project order item identifier

>{Integer}</ProjectOrderItemId>
12
               <Category
Category

The category of this project order item: Material, Hours or Expenses

Possible domain values can be found here

>{String}</Category>
13
               <ProjectOrderLink
ProjectOrderLink

Project order item reference

>{String}</ProjectOrderLink>
14
          </ProjectOrderItem>
15
          <Sales>
16
               <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
17
               <Price
Price

Equals to ACCRUEDPRICE if this billing basis is not yet invoiced and will be used as price in the invoice. Will not be changed billing basis is invoiced, even if ACCRUEDPRICE is changed

>{Decimal}</Price>
18
          </Sales>
19
          <SalesConverted
SalesConverted

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.SalesConverted in your request URI to get this field

>
20
               <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.SalesConverted in your request URI to get this field

>{String}</Currency>
21
               <Price
Price

Equals to CACCRUEDPRICE if this billing basis is not yet invoiced and will be used as cprice in the invoice. Will not be changed billing basis is invoiced, even if CACCRUEDPRICE is changed

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.SalesConverted in your request URI to get this field

>{Decimal}</Price>
22
          </SalesConverted>
23
          <BillingItem
BillingItem

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>
24
               <ItemId
ItemId

Item-number of the object

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>{Integer}</ItemId>
25
               <ItemType
ItemType

Type of item

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>{String}</ItemType>
26
               <Status
Status

Status of the item/object.

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>{Integer}</Status>
27
               <Product
Product

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>
28
                    <ProductId
ProductId

Product identifier

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>{Integer}</ProductId>
29
                    <Name
Name

Name of the product

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>{String}</Name>
30
                    <ProductLink
ProductLink

Product reference

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>{String}</ProductLink>
31
               </Product>
32
               <Object
Object

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>
33
                    <ObjectId
ObjectId

Identifier of the object

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>{Integer}</ObjectId>
34
                    <ObjectType
ObjectType

Type of object

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>{String}</ObjectType>
35
                    <RegistrationDate
RegistrationDate

Date of registration

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>{Date}</RegistrationDate>
36
                    <AccountingPeriod
AccountingPeriod

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>
37
                         <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>{Integer}</AccountingPeriodId>
38
                         <Period
Period

Accounting period

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>{Integer}</Period>
39
                         <AccountingPeriodLink
AccountingPeriodLink

Accounting period reference

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>{String}</AccountingPeriodLink>
40
                    </AccountingPeriod>
41
                    <ObjectLink
ObjectLink

API reference to the object

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>{String}</ObjectLink>
42
               </Object>
43
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>{String}</RamBaseKey>
44
               <ItemLink
ItemLink

API reference to the item

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

>{String}</ItemLink>
45
          </BillingItem>
46
          <Source
Source

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.Source in your request URI to get this field

>
47
               <ObjectType
ObjectType

The object type name for the archive

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.Source in your request URI to get this field

>{String}</ObjectType>
48
               <ObjectId
ObjectId

Identifier of the object

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.Source in your request URI to get this field

>{Integer}</ObjectId>
49
               <ObjectLink
ObjectLink

Document reference

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.Source in your request URI to get this field

>{String}</ObjectLink>
50
               <ItemId
ItemId

Reference to the item id of the object

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.Source in your request URI to get this field

>{Integer}</ItemId>
51
               <ItemLink
ItemLink

Document item reference

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.Source in your request URI to get this field

>{String}</ItemLink>
52
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.Source in your request URI to get this field

>{String}</RamBaseKey>
53
          </Source>
54
          <BillableSaleLink
BillableSaleLink

Project order billing basis reference

>{String}</BillableSaleLink>
55
     </BillableSale>
56
     <Paging
Paging

Detailed paging information for this list.

>
57
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
58
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
59
          <Page
Page

Page index

>{Integer}</Page>
60
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
61
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
62
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
63
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
64
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
65
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
66
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
67
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
68
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
69
     </Paging>
70
</BillableSales>
1
{
2
     "billableSales": [
3
          {
4
               "billableSaleId
BillableSaleId

The billing basis sequence number

": "{Integer}",
5
               "status
Status

Status of billing basis

Possible domain values can be found here

": "{Integer}",
6
               "type
Type

The object type name for the archive

": "{String}",
7
               "isForwarded
IsForwarded

Determines whether CIN (sales invoice) has been forwarded to CCN (sales credit note)

": "{Boolean}",
8
               "incurredCostDate
IncurredCostDate

The date the revenues became incurred. E.g the date a worker logs hours for (WOL.EndDate)

": "{Date}",
9
               "quantity
Quantity

The quantity that will be invoiced; consumed quantity for material, billable hours from work log and "1" for expenses

": "{Decimal}",
10
               "note
Note

A note that will be copied to note in sales invoice item

": "{String}",
11
               "projectOrderItem": {
12
                    "projectOrderItemId
ProjectOrderItemId

Project order item identifier

": "{Integer}",
13
                    "category
Category

The category of this project order item: Material, Hours or Expenses

Possible domain values can be found here

": "{String}",
14
                    "projectOrderLink
ProjectOrderLink

Project order item reference

": "{String}"
15
               },
16
               "sales": {
17
                    "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
18
                    "price
Price

Equals to ACCRUEDPRICE if this billing basis is not yet invoiced and will be used as price in the invoice. Will not be changed billing basis is invoiced, even if ACCRUEDPRICE is changed

": "{Decimal}"
19
               },
20
               "salesConverted
SalesConverted

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.SalesConverted in your request URI to get this field

": {
21
                    "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.SalesConverted in your request URI to get this field

": "{String}",
22
                    "price
Price

Equals to CACCRUEDPRICE if this billing basis is not yet invoiced and will be used as cprice in the invoice. Will not be changed billing basis is invoiced, even if CACCRUEDPRICE is changed

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.SalesConverted in your request URI to get this field

": "{Decimal}"
23
               },
24
               "billingItem
BillingItem

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": {
25
                    "itemId
ItemId

Item-number of the object

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": "{Integer}",
26
                    "itemType
ItemType

Type of item

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": "{String}",
27
                    "status
Status

Status of the item/object.

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": "{Integer}",
28
                    "product
Product

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": {
29
                         "productId
ProductId

Product identifier

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": "{Integer}",
30
                         "name
Name

Name of the product

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": "{String}",
31
                         "productLink
ProductLink

Product reference

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": "{String}"
32
                    },
33
                    "object
Object

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": {
34
                         "objectId
ObjectId

Identifier of the object

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": "{Integer}",
35
                         "objectType
ObjectType

Type of object

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": "{String}",
36
                         "registrationDate
RegistrationDate

Date of registration

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": "{Date}",
37
                         "accountingPeriod
AccountingPeriod

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": {
38
                              "accountingPeriodId
AccountingPeriodId

Accounting period identifier

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": "{Integer}",
39
                              "period
Period

Accounting period

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": "{Integer}",
40
                              "accountingPeriodLink
AccountingPeriodLink

Accounting period reference

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": "{String}"
41
                         },
42
                         "objectLink
ObjectLink

API reference to the object

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": "{String}"
43
                    },
44
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": "{String}",
45
                    "itemLink
ItemLink

API reference to the item

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.BillingItem in your request URI to get this field

": "{String}"
46
               },
47
               "source
Source

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.Source in your request URI to get this field

": {
48
                    "objectType
ObjectType

The object type name for the archive

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.Source in your request URI to get this field

": "{String}",
49
                    "objectId
ObjectId

Identifier of the object

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.Source in your request URI to get this field

": "{Integer}",
50
                    "objectLink
ObjectLink

Document reference

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.Source in your request URI to get this field

": "{String}",
51
                    "itemId
ItemId

Reference to the item id of the object

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.Source in your request URI to get this field

": "{Integer}",
52
                    "itemLink
ItemLink

Document item reference

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.Source in your request URI to get this field

": "{String}",
53
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

This field is greyed out because it is an expandable field. You have to add $expand=BillableSale.Source in your request URI to get this field

": "{String}"
54
               },
55
               "billableSaleLink
BillableSaleLink

Project order billing basis reference

": "{String}"
56
          }
57
     ],
58
     "paging
Paging

Detailed paging information for this list.

": {
59
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
60
          "position
Position

Position of the first element in the list

": "{Integer}",
61
          "page
Page

Page index

": "{Integer}",
62
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
63
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
64
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
65
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
66
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
67
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
68
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
69
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
70
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
71
     }
72
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 102738 HTTP 404 Price list not found
Error 100089 HTTP 404 Product {0} not found