Sales Orders

Update Sales Order

Changed on

Update Sales Order

patch/accounting/sales-orders/{id}

Request

  • Base URL: https://unify.apideck.com
  • URL: https://unify.apideck.com/accounting/sales-orders/{id}
  • Auth: API key in header Authorization

Path parameters

idstring required

ID of the record you are acting upon.

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-company-idstring

The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.

Request body

idstring

A unique identifier for an object.

downstream_idstring nullable

The third-party API ID of original entity

numberstring nullable

Sales order number, as assigned by the accounting system.

quote_idstring nullable

The unique identifier for the quote.

invoice_idstring nullable

ID of the invoice created from this sales order. Populated when the accounting system records a single invoice on the order (see the connector gotchas); null when the order has not been invoiced, or when it was invoiced in parts and the system keeps no single link.

company_idstring nullable

The company ID the transaction belongs to

department_idstring nullable

The ID of the department

location_idstring nullable

The ID of the location

project_idstring

The unique identifier for the linked project.

subsidiary_idstring nullable

The ID of the subsidiary

order_datestring date nullable

Date the sales order was placed - YYYY-MM-DD.

delivery_datestring date nullable

The requested delivery date: the date the customer asked to receive the goods or services - YYYY-MM-DD. Promised ship dates and payment due dates are not mapped here.

order_typestring nullable

The order or transaction type of the sales order, as configured in the accounting system. On create, selects the type to create when the system supports several; omit to use the connection default. See the connector gotchas for the values each system accepts.

termsstring nullable

Payment terms of the sales order.

terms_idstring nullable

The ID of the payment terms

po_numberstring nullable

A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order.

referencestring nullable

Optional reference identifier for the transaction.

status'draft' | 'open' | 'on_hold' | 'back_ordered' | 'invoiced' | 'closed' | 'cancelled' | 'other' nullable

Sales order status, in order of precedence: cancelled; closed (the order is closed or completed, whether or not it was billed); invoiced (fully billed but not yet closed); back_ordered; on_hold (including credit hold); draft (including pending approval); open (every other active state, including partially shipped and partially invoiced); other for states that fit none of these.

currency'UNKNOWN_CURRENCY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRC' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' | 'ETH' nullable

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

currency_ratenumber nullable

Currency Exchange Rate at the time entity was recorded/generated.

tax_inclusiveboolean nullable

Amounts are including tax

sub_totalnumber nullable

Sub-total amount, normally before tax.

total_taxnumber nullable

Total tax amount applied to this sales order.

tax_codestring nullable

Applicable tax id/code override if tax is not supplied on a line item basis.

discount_percentagenumber nullable

Discount percentage applied to this sales order.

discount_amountnumber nullable

Discount amount applied to this sales order.

totalnumber nullable

Total amount of the sales order, including tax.

unbilled_amountnumber nullable

Amount of the sales order not yet invoiced. Not the amount owed: see balance on the invoices created from the order for that.

shipping_methodstring nullable

Shipping method or carrier code for the order.

payment_methodstring nullable

Payment method used for the transaction, such as cash, credit card, bank transfer, or check

customer_memostring nullable

Message to the customer, shown on the sales order.

notesstring nullable

Internal notes for the sales order, not shown to the customer.

template_idstring nullable

Optional sales order template

source_document_urlstring nullable

URL link to a source document - shown as 'Go to [appName]' in the downstream app.

custom_mappingsCustomMappings nullable

When custom mappings are configured on the resource, the result is included here.

row_versionstring nullable

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

updated_bystring nullable

The user who last updated the object.

created_bystring nullable

The user who created the object.

updated_atstring date-time nullable

The date and time when the object was last updated.

created_atstring date-time nullable

The date and time when the object was created.

Example request

{
  "id": "12345",
  "downstream_id": "12345",
  "number": "SO000123",
  "customer": {
    "id": "12345",
    "display_id": "CUST00101",
    "display_name": "Windsurf Shop",
    "name": "Windsurf Shop",
    "company_name": "The boring company",
    "email": "boring@boring.com"
  },
  "quote_id": "123456",
  "invoice_id": "123456",
  "company_id": "12345",
  "department_id": "12345",
  "location_id": "12345",
  "project_id": "12345",
  "subsidiary_id": "12345",
  "order_date": "2020-09-30",
  "delivery_date": "2020-10-15",
  "order_type": "SO",
  "terms": "Net 30",
  "terms_id": "12345",
  "po_number": "90000117",
  "reference": "INV-2024-001",
  "status": "open",
  "currency": "USD",
  "currency_rate": 0.69,
  "tax_inclusive": true,
  "sub_total": 27500,
  "total_tax": 2500,
  "tax_code": "1234",
  "discount_percentage": 5.5,
  "discount_amount": 25,
  "total": 30000,
  "unbilled_amount": 30000,
  "shipping_method": "FEDEX",
  "payment_method": "cash",
  "customer_memo": "Thank you for your order!",
  "notes": "Ship with next consignment",
  "line_items": [
    {
      "id": "12345",
      "row_id": "12345",
      "code": "120-C",
      "line_number": 1,
      "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
      "type": "sales_item",
      "tax_amount": 27500,
      "total_amount": 27500,
      "quantity": 1,
      "unit_price": 27500.5,
      "unit_of_measure": "pc.",
      "discount_percentage": 0.01,
      "discount_amount": 19.99,
      "service_date": "2024-01-15",
      "category_id": "12345",
      "location_id": "12345",
      "department_id": "12345",
      "subsidiary_id": "12345",
      "shipping_id": "12345",
      "memo": "Some memo",
      "prepaid": true,
      "item": {
        "id": "12344",
        "code": "120-C",
        "name": "Model Y"
      },
      "taxable": true,
      "tax_applicable_on": "Domestic_Purchase_of_Goods_and_Services",
      "tax_recoverability": "Fully_Recoverable",
      "tax_method": "Due_to_Supplier",
      "worktags": [
        {
          "id": "123456",
          "value": "New York"
        }
      ],
      "tax_rate": {
        "id": "123456",
        "code": "N-T",
        "name": "GST on Purchases",
        "rate": 10
      },
      "tracking_categories": [
        {
          "id": "123456",
          "code": "100",
          "name": "New York",
          "parent_id": "123456",
          "parent_name": "New York"
        }
      ],
      "ledger_account": {
        "id": "123456",
        "name": "Bank account",
        "nominal_code": "N091",
        "code": "453",
        "parent_id": "123456",
        "display_id": "123456"
      },
      "custom_fields": [
        {
          "id": "2389328923893298",
          "name": "employee_level",
          "ref_name": "Marketing",
          "description": "Employee Level",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "row_version": "1-12345",
      "updated_by": "12345",
      "created_by": "12345",
      "created_at": "2020-09-30T07:43:32.000Z",
      "updated_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "billing_address": {
    "id": "123",
    "type": "primary",
    "string": "25 Spring Street, Blackburn, VIC 3130",
    "name": "HQ US",
    "line1": "Main street",
    "line2": "apt #",
    "line3": "Suite #",
    "line4": "delivery instructions",
    "line5": "Attention: Finance Dept",
    "street_number": "25",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94104",
    "country": "US",
    "latitude": "40.759211",
    "longitude": "-73.984638",
    "county": "Santa Clara",
    "contact_name": "Elon Musk",
    "salutation": "Mr",
    "phone_number": "111-111-1111",
    "fax": "122-111-1111",
    "email": "elon@musk.com",
    "website": "https://elonmusk.com",
    "notes": "Address notes or delivery instructions.",
    "row_version": "1-12345"
  },
  "shipping_address": {
    "id": "123",
    "type": "primary",
    "string": "25 Spring Street, Blackburn, VIC 3130",
    "name": "HQ US",
    "line1": "Main street",
    "line2": "apt #",
    "line3": "Suite #",
    "line4": "delivery instructions",
    "line5": "Attention: Finance Dept",
    "street_number": "25",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94104",
    "country": "US",
    "latitude": "40.759211",
    "longitude": "-73.984638",
    "county": "Santa Clara",
    "contact_name": "Elon Musk",
    "salutation": "Mr",
    "phone_number": "111-111-1111",
    "fax": "122-111-1111",
    "email": "elon@musk.com",
    "website": "https://elonmusk.com",
    "notes": "Address notes or delivery instructions.",
    "row_version": "1-12345"
  },
  "tracking_categories": [
    {
      "id": "123456",
      "code": "100",
      "name": "New York",
      "parent_id": "123456",
      "parent_name": "New York"
    }
  ],
  "template_id": "123456",
  "source_document_url": "https://www.ordersolution.com/order/123456",
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "ref_name": "Marketing",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "row_version": "1-12345",
  "updated_by": "12345",
  "created_by": "12345",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "created_at": "2020-09-30T07:43:32.000Z",
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response

Sales Orders

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "acumatica",
  "resource": "SalesOrders",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Changes