HomeAPI Reference
API Reference

Create/Update Order by External Reference

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

Creates a new order or updates an existing order using an external reference number.

Use Cases:

  • Integration from external systems (CRM, ERP)
  • Idempotent order creation
  • Upsert operations based on external ID

Behavior: If order with externalRefNumber exists, it will be updated. Otherwise, a new order is created.

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

External system reference number (unique identifier from source system)

Body Params

Complete order entity with 405+ fields organized into functional groups:

Core Fields (Required):

  • Order identification and classification
  • Effective dates and business unit
  • Currency and pricing
  • Customer associations (bill-to, sell-to)
  • Billing configuration

Optional Field Groups:

  • Custom Attributes: attribute1V-25V (VARCHAR), attribute1N-15N (NUMBER), attribute1D-15D (DATE)
  • Tax Attributes: taxAttribute1V-30V, line tax attributes
  • Location Fields: origin/termination (header and line level)
  • Price Adjustments: priceAdjAttribute1V-5V/1N-5N/1D-5D
  • Revenue Attributes: hdrRevAttribute1V-15V/1N-10N/1D-5D, lineRevAttribute1V-15V/1N-10N/1D-5D
  • Renewal Configuration: renewal terms, pricing, cycles
  • Partner/Vendor: partner associations and payment terms
  • Commitment: commitment IDs and amounts

string
required

Unique order number (REQUIRED)

string
required

Order type code (REQUIRED)

string
required

Order category (REQUIRED)

string
required

Order source system (REQUIRED)

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

Evergreen flag - Y for auto-renewing, N for fixed term (REQUIRED)

Allowed:
date
required

Effective start date yyyy-MM-dd (REQUIRED)

date

Effective end date yyyy-MM-dd

string
required

Business unit code (REQUIRED)

string
required

Currency name (REQUIRED)

string

3-letter ISO currency code

string
required

Price list name (REQUIRED)

string
required

Bill-to account number (REQUIRED)

string
required

Bill-to site number (REQUIRED)

string
required

Bill-to contact number (REQUIRED)

string
required

Billing cycle (REQUIRED)

string
required

Billing frequency (REQUIRED)

string
required

Invoicing rule - ADVANCE or ARREARS (REQUIRED)

string
required

Payment term (REQUIRED)

string

Order description

string

External reference number

string

Purchase order number

string
enum
^(?:Y|N)$

Do not bill flag - prevents billing

Allowed:
string
enum

For UPDATE only: triggers credit memo and rebill process

Allowed:
string

For UPDATE with creditRebillFlag=Y: reason code for credit/rebill

date

For UPDATE with creditRebillFlag=Y: effective date for changes

string

Context identifier for custom attributes

string

Custom VARCHAR attribute 1 (25 total: attribute1V through attribute25V)

number

Custom NUMBER attribute 1 (15 total: attribute1N through attribute15N)

date

Custom DATE attribute 1 (15 total: attribute1D through attribute15D) yyyy-MM-dd

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