Create 'OutdoorSectionContractRevenueRow'

Request

Security

customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret

Bodyapplication/json

articleobject(Article)required

titlestring, <= 255 charactersrequired

unit_amountnumber, (float)required

unit_pricenumber, (float)required

contractobject(OutdoorSectionContract)required

organizationobject or null(Organization)

custom_idstring or null, <= 128 characters

start_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: end_date

end_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: start_date

accounted_start_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: accounted_end_date

This value must be set together with the following fields: accounted_end_date

This value requires that the following fields are also set: start_date, end_date

accounted_end_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: accounted_start_date

This value must be set together with the following fields: accounted_start_date

This value requires that the following fields are also set: start_date, end_date

periods_adjusts_total_amountboolean

excempt_from_monthsArray of any or null

ignore_retroactivity_tostring or null, (date)

custom_dimension_valuestring or null, <= 255 characters

POST

/revenue/revenuerows/outdoorsectioncontractrevenuerow/

curl -i -X POST \
  https://dev.api.pigello.io/revenue/revenuerows/outdoorsectioncontractrevenuerow/ \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '{
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "article": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "title": "string",
    "start_date": "2019-08-24",
    "end_date": "2019-08-24",
    "accounted_start_date": "2019-08-24",
    "accounted_end_date": "2019-08-24",
    "unit_amount": 0.1,
    "unit_price": 0.1,
    "periods_adjusts_total_amount": true,
    "excempt_from_months": [
      null
    ],
    "ignore_retroactivity_to": "2019-08-24",
    "custom_dimension_value": "string",
    "contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json

idstring, (uuid)read-onlyrequired

Additional Validation Information:

Must be unique

articleobject(Article)required

titlestring, <= 255 charactersrequired

unit_amountnumber, (float)required

unit_pricenumber, (float)required

contractobject(OutdoorSectionContract)required

organizationobject or null(Organization)

custom_idstring or null, <= 128 characters

created_atstring, (date-time)read-only

start_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: end_date

end_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: start_date

accounted_start_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: accounted_end_date

This value must be set together with the following fields: accounted_end_date

This value requires that the following fields are also set: start_date, end_date

accounted_end_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: accounted_start_date

This value must be set together with the following fields: accounted_start_date

This value requires that the following fields are also set: start_date, end_date

periods_adjusts_total_amountboolean

excempt_from_monthsArray of any or null

ignore_retroactivity_tostring or null, (date)

custom_dimension_valuestring or null, <= 255 characters

customer_earnings_settingobject or null(CustomerEarningsRevenueSetting)read-only

customer_earnings_reportobject or null(CustomerEarningsReport)read-only

is_customer_earnings_report_penaltybooleanread-only

indexation_usageobject or null(IndexationSettingUsage)read-only

automatic_distribution_valueobject or null(AutomaticDistributionTypeValue)read-only

automatic_distribution_quotaobject or null(AutomaticDistributionQuota)read-only

measurement_seriesobject or null(MeasurementSeries)read-only

from_retroactive_proposalobject or null(RetroactiveOutdoorSectionRevenueProposal)read-only

Additional Validation Information:

Must be unique

applied_indexation_usageanyread-only

tagsanyread-only

customer_columnsanyread-only

pending_monitor_approval_amountanyread-only

Response

{
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "custom_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "title": "string",
  "start_date": "2019-08-24",
  "end_date": "2019-08-24",
  "accounted_start_date": "2019-08-24",
  "accounted_end_date": "2019-08-24",
  "unit_amount": 0.1,
  "unit_price": 0.1,
  "periods_adjusts_total_amount": true,
  "excempt_from_months": [
    null
  ],
  "ignore_retroactivity_to": "2019-08-24",
  "custom_dimension_value": "string",
  "customer_earnings_setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_earnings_report": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "is_customer_earnings_report_penalty": true,
  "indexation_usage": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "automatic_distribution_value": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "automatic_distribution_quota": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "measurement_series": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "from_retroactive_proposal": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "applied_indexation_usage": null,
  "tags": null,
  "customer_columns": null,
  "pending_monitor_approval_amount": null
}