Update Order

put

https://api.recvue.com/api/v2.0/orders/{orderId}

Updates an existing order.

Update Capabilities:

Modify order attributes and dates
Update billing and payment information
Change customer associations
Apply credit and rebill operations

Credit & Rebill: Set creditRebillFlag=Y along with reasonCode and effectiveDate to trigger credit memo and rebill process

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

orderId

int64

required

Unique order identifier

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

orderNumber

string

required

Unique order number (REQUIRED)

orderType

string

required

Order type code (REQUIRED)

orderCategory

string

required

Order category (REQUIRED)

orderSource

string

required

Order source system (REQUIRED)

evergreenFlag

string

enum

required

^(?:Y|N)$

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

Allowed:

effectiveStartDate

date

required

Effective start date yyyy-MM-dd (REQUIRED)

effectiveEndDate

date

Effective end date yyyy-MM-dd

businessUnit

string

required

Business unit code (REQUIRED)

currency

string

required

Currency name (REQUIRED)

currencyCode

string

3-letter ISO currency code

priceList

string

required

Price list name (REQUIRED)

billToAccountNumber

string

required

Bill-to account number (REQUIRED)

billToSiteNumber

string

required

Bill-to site number (REQUIRED)

billToContactNumber

string

required

Bill-to contact number (REQUIRED)

billingCycle

string

required

Billing cycle (REQUIRED)

billingFrequency

string

required

Billing frequency (REQUIRED)

invoicingRule

string

required

Invoicing rule - ADVANCE or ARREARS (REQUIRED)

paymentTerm

string

required

Payment term (REQUIRED)

description

string

Order description

referenceNumber

string

External reference number

poNumber

string

Purchase order number

doNotBillFlag

string

enum

^(?:Y|N)$

Do not bill flag - prevents billing

Allowed:

creditRebillFlag

string

enum

For UPDATE only: triggers credit memo and rebill process

Allowed:

reasonCode

string

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

effectiveDate

date

For UPDATE with creditRebillFlag=Y: effective date for changes

attributeContext

string

Context identifier for custom attributes

attribute1V

string

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

attribute1N

number

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

attribute1D

date

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

Responses

400

401

404

500

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Order updated successfully