HomeAPI Reference
API Reference

Create Order Line by External Reference

post
https://api.recvue.com/api/v2.0/orderlines/external/

Creates a new order line using an external reference number for idempotent operations.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

External system reference

Body Params

Complete order line entity with 417+ fields organized into functional groups:

Core Fields (Required):

  • Order and line identification
  • Item details and quantities
  • Pricing information
  • Billing configuration
  • Accounting rules

Optional Field Groups:

  • Custom Attributes: attribute1V-25V (VARCHAR), attribute1N-15N (NUMBER), attribute1D-15D (DATE)
  • Line Tax Attributes: lineTaxAttribute1V-30V
  • Origin/Termination Locations: lineOriginSite, lineOriginCountry, lineOriginState, lineTerminationSite, etc.
  • Price Adjustments: priceAdjAttribute1V-5V/1N-5N/1D-5D
  • Revenue Attributes: hdrRevAttribute1V-15V/1N-10N/1D-5D, lineRevAttribute1V-15V/1N-10N/1D-5D
  • Partner/Vendor: partner details and payment configuration
  • Tier Pricing: tier name references
  • Commitment: commitment IDs and amounts
  • Task Properties: for usage-based billing

string
required

Order number (REQUIRED)

double
required

Line number (REQUIRED)

string
required

Business unit (REQUIRED)

string
required

Item description (REQUIRED)

string

Item name/code

double
required

Quantity (REQUIRED)

double
required

Unit price (REQUIRED)

string
enum
required
^(?:Y|N)$

Evergreen flag Y/N (REQUIRED)

Allowed:
string
required

Line type - RECURRING, ONE_TIME, USAGE (REQUIRED)

string
required

Billing cycle (REQUIRED)

string
required

Billing frequency (REQUIRED)

string
required

Invoicing rule - ADVANCE or ARREARS (REQUIRED)

string
required

Accounting rule for revenue recognition (REQUIRED)

date

Line effective start date yyyy-MM-dd

date

Line effective end date yyyy-MM-dd

string

Unit of measure

string

Line status

string
enum
^(?:Y|N)$

Do not bill flag

Allowed:
string

Tier pricing header name reference

string

Custom attribute context identifier

string

Custom VARCHAR attr 1 (25 total: attribute1V-25V)

number

Custom NUMBER attr 1 (15 total: attribute1N-15N)

date

Custom DATE attr 1 (15 total: attribute1D-15D)

string

Credit and rebill flag (for updates only)

Responses

400
401
500

Updated 3 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago