API

Sales APIs

POST sales/delivery-projects

Create a new sales delivery project

HTTP method POST
URI https://api.rambase.net/sales/delivery-projects
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 2261, version 4

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
<SalesDeliveryProject>
2
     <Name
Name

Required/mandatory field

Name of sales delivery

Minimum value: 1

>{String}</Name>
3
     <Description
Description

Description of sales delivery

This field is optional.

>{String}</Description>
4
     <Customer
Customer

Required/mandatory field

Customer this sales delivery overview is used for

>
5
          <CustomerId
CustomerId

Required/mandatory field

Customer identifier

Minimum value: 10000

>{Integer}</CustomerId>
6
     </Customer>
7
     <FinanceProject
FinanceProject

This field is optional.

>
8
          <FinanceProjectId
FinanceProjectId

Finance project identifier

Minimum value: 1

This field is optional.

>{Integer}</FinanceProjectId>
9
     </FinanceProject>
10
</SalesDeliveryProject>
1
{
2
     "salesDeliveryProject": {
3
          "name
Name

Required/mandatory field

Name of sales delivery

Minimum value: 1

": "{String}",
4
          "description
Description

Description of sales delivery

This field is optional.

": "{String}",
5
          "customer
Customer

Required/mandatory field

Customer this sales delivery overview is used for

": {
6
               "customerId
CustomerId

Required/mandatory field

Customer identifier

Minimum value: 10000

": "{Integer}"
7
          },
8
          "financeProject
FinanceProject

This field is optional.

": {
9
               "financeProjectId
FinanceProjectId

Finance project identifier

Minimum value: 1

This field is optional.

": "{Integer}"
10
          }
11
     }
12
}

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.

$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
$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.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

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.

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

Format:
1
<SalesDeliveryProject>
2
     <SalesDeliveryProjectId
SalesDeliveryProjectId

Sales delivery project identifier

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

Status of sales delivery

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

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Name
Name

Name of sales delivery

>{String}</Name>
6
     <Description
Description

Description of sales delivery

>{String}</Description>
7
     <Customer
Customer

Customer this sales delivery overview is used for

>
8
          <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
9
          <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>{String}</Name>
10
          <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
11
     </Customer>
12
     <FinanceProject>
13
          <FinanceProjectId
FinanceProjectId

Finance project identifier

>{Integer}</FinanceProjectId>
14
          <Name
Name

Name of finance project

>{String}</Name>
15
          <LastGeneralLedgerPostingPeriod
LastGeneralLedgerPostingPeriod

Last general ledger posting period of finance project

>{Integer}</LastGeneralLedgerPostingPeriod>
16
          <FinanceProjectLink
FinanceProjectLink

Finance project reference

>{String}</FinanceProjectLink>
17
     </FinanceProject>
18
</SalesDeliveryProject>
1
{
2
     "salesDeliveryProject": {
3
          "salesDeliveryProjectId
SalesDeliveryProjectId

Sales delivery project identifier

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

Status of sales delivery

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "name
Name

Name of sales delivery

": "{String}",
7
          "description
Description

Description of sales delivery

": "{String}",
8
          "customer
Customer

Customer this sales delivery overview is used for

": {
9
               "customerId
CustomerId

Customer identifier

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

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
11
               "customerLink
CustomerLink

Customer reference

": "{String}"
12
          },
13
          "financeProject": {
14
               "financeProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

": "{String}",
16
               "lastGeneralLedgerPostingPeriod
LastGeneralLedgerPostingPeriod

Last general ledger posting period of finance project

": "{Integer}",
17
               "financeProjectLink
FinanceProjectLink

Finance project reference

": "{String}"
18
          }
19
     }
20
}

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 101420 HTTP 404 Setting definition not found
Error 102750 HTTP 400 Number of parameter values does not match the number of parameters in the formula
Error 102749 HTTP 400 Missing parameter value for parameter {0}
Error 102747 HTTP 400 Error in formula: {0}
Error 103343 HTTP 400 Illegal update : Accountingperiod {0} is closed.
Error 103342 HTTP 400 Illegal Update : Accountingperiod {0} has agio calculations.
Error 106408 HTTP 403 You have no permission to create subscription item in sales order
Error 106957 HTTP 400 Only rental or subscription products can be used in recurring contract's lines
Error 106962 HTTP 400 Product of this type (WP) cannot be added to this type of sales order
Error 107055 HTTP 400 The rental date can only be set back {0} days
Error 102484 HTTP 400 Asset is required for general ledger account {0}
Error 102485 HTTP 400 Dimension {0} ({1}) is required for general ledger account {2}
Error 101313 HTTP 400 Department number is not valid: {0}
Error 101320 HTTP 400 The project number is not valid: {0}
Error 101500 HTTP 400 Project {0} could not be used : Check project FromPeriod and ToPeriod.
Error 101501 HTTP 400 Asset is not allowed on general ledger account {0}
Error 101326 HTTP 400 The asset number is not valid : {0}
Error 102486 HTTP 400 Invalid value for dimension {0}