API

Sales APIs

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

Project order's billable sale for the provided identifier

HTTP method GET
URI https://api.rambase.net/sales/project-orders/{projectOrderId}/billable-sales/{billableSaleId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {projectOrderId} Project order identifier
Integer, minimum 100000
- URI parameter {billableSaleId} The billing basis sequence number
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 4939, version 28

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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.

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

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

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
<BillableSale>
2
     <BillableSaleId
BillableSaleId

The billing basis sequence number

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

Status of billing basis

Possible domain values can be found here

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

The object type name for the archive

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

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

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

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

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

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

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

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

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

Project order item identifier

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

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

Possible domain values can be found here

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

Project order item reference

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

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
16
          <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>
17
     </Sales>
18
     <SalesConverted
SalesConverted

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

>
19
          <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=SalesConverted in your request URI to get this field

>{String}</Currency>
20
          <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=SalesConverted in your request URI to get this field

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

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

>
23
          <ItemId
ItemId

Item-number of the object

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

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

Type of item

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

>{String}</ItemType>
25
          <Product
Product

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

>
26
               <ProductId
ProductId

Product identifier

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

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

Name of the product

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

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

Product reference

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

>{String}</ProductLink>
29
          </Product>
30
          <Object
Object

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

>
31
               <ObjectId
ObjectId

Identifier of the object

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

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

Type of object

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

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

Date of registration

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

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

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

>
35
                    <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

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

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

Accounting period

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

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

Accounting period reference

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

>{String}</AccountingPeriodLink>
38
               </AccountingPeriod>
39
               <ObjectLink
ObjectLink

API reference to the object

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

>{String}</ObjectLink>
40
          </Object>
41
          <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=BillingItem in your request URI to get this field

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

API reference to the item

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

>{String}</ItemLink>
43
     </BillingItem>
44
     <Source
Source

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

>
45
          <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=Source in your request URI to get this field

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

Identifier of the object

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

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

Document reference

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

>{String}</ObjectLink>
48
          <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=Source in your request URI to get this field

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

Document item reference

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

>{String}</ItemLink>
50
          <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=Source in your request URI to get this field

>{String}</RamBaseKey>
51
     </Source>
52
</BillableSale>
1
{
2
     "billableSale": {
3
          "billableSaleId
BillableSaleId

The billing basis sequence number

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

Status of billing basis

Possible domain values can be found here

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

The object type name for the archive

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

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

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

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

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

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

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

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

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

Project order item identifier

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

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

Possible domain values can be found here

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

Project order item reference

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

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
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}"
18
          },
19
          "salesConverted
SalesConverted

This field is greyed out because it is an expandable field. You have to add $expand=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=SalesConverted in your request URI to get this field

": "{String}",
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=SalesConverted in your request URI to get this field

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

This field is greyed out because it is an expandable field. You have to add $expand=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=BillingItem in your request URI to get this field

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

Type of item

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

": "{String}",
26
               "product
Product

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

": {
27
                    "productId
ProductId

Product identifier

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

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

Name of the product

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

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

Product reference

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

": "{String}"
30
               },
31
               "object
Object

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

": {
32
                    "objectId
ObjectId

Identifier of the object

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

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

Type of object

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

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

Date of registration

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

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

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

": {
36
                         "accountingPeriodId
AccountingPeriodId

Accounting period identifier

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

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

Accounting period

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

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

Accounting period reference

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

": "{String}"
39
                    },
40
                    "objectLink
ObjectLink

API reference to the object

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

": "{String}"
41
               },
42
               "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=BillingItem in your request URI to get this field

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

API reference to the item

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

": "{String}"
44
          },
45
          "source
Source

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

": {
46
               "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=Source in your request URI to get this field

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

Identifier of the object

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

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

Document reference

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

": "{String}",
49
               "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=Source in your request URI to get this field

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

Document item reference

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

": "{String}",
51
               "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=Source in your request URI to get this field

": "{String}"
52
          }
53
     }
54
}

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 100055 HTTP 403 You have only admittance to your own objects