Acknowledge receipt of an invoice.

Authentication v1

Identity APIs
User
Address
Auth

User Self Service APIs

Introduction
User Self Service APIs
Authentication APIs

Experiences v2 (XM v2)

XM
Pages
Global Components
Menu

Experiences v1 (XM v1)

XM
Pages
Global Components
Menu

Product Catalog

Product Catalog
Category
Product
Attributes
Bulk Import

Orders v2 (OMS v2)

Order Management System
Order
Order Attribute
Developer Guide
Order Return
Payment Status
Package Tracking
Cross Border
Order Cancellation
Appeasement
Allocation
Configuration
Fraud Configuration
Target Configuration
Location
Location Attribute
Inventory Network
Inventory
Inventory Counter
Inventory Bulk Operation
Inventory Attribute
Inventory Upload Log
Shipment
Shipping Method
Webhook
Notification
Export
Invoice
Fraud
Backorder Preorder Reservation
List

Orders v1 (OMS v1)

Order Management System
Cart
Bill To
Ship To
Wishlist
Cart Decoupled
Warehouse
Inventory
Attributes
List
Tax/Address Validate
Shipping
Payments
Order

Offers v2

Offers
Developer Guide
Promotion
Price Kind
Dynamic Pricing Engine
Segment
Coupon
Coupon Codes
Product
Price List
Attributes
Item
Price Guard
Global Exclusion
Upload Price CSV
Pricing
Redemption
Exports

Offers v1

Offers
Login API
Promotions
Pricing

Subscriptions (SMT API)

Subscriptions API
Cancellation Reasons
Subscription Discounts
Subscriptions
Subscribers
Orders

Loyalty (Member)

Member APIs
Inquire
Discounts
Redeem
Earn
Members

Dropship

Dropship API
Shipments
Products
Invoices
Connections
Inventory
Developer Guide
Returns
Orders

Cart API

Cart
Order Draft
Attribute
Adjustments
Shipping
Cart

Checkout API

Checkout
Checkout

Customer

Core Concepts
Customer Service
Organization
User Party
Organization Group Addresses
User Internal Party
Organization Contracts
Party
Party Contracts
Contracts
User
Search
User Trait
Organization Users
Address
User Address
Trait
Party Address
Party Trait
Organization Group Users
Internal Party
Contract Pricelist
Internal Parties Party
Account
Party Account
Organization Addresses
Organization Groups
Individual Addresses
Users Organization
Individual

PUT

retailers

{retailer_pk}

invoices

{id}

acknowledge

object

retailer

object

name

string

code

string

is_rcn_retailer

boolean

is_onboarded

boolean

platform

enum<string>

requires_subscription

enum<string>

brand_permit_creation_allowed

boolean

website

string

status

enum<string>

brand

object

name

string

code

string

website

string

is_on_rcn

boolean

requires_subscription

enum<string>

subscription_expires_at

string

grace_period_ends_at

string

inventory_policy

enum<string>

status

enum<string>

currency

object

name

string

symbol

string

invoice_number

string

terms_type

enum<string>

terms_description

string

terms_net_days_due

integer

terms_date_due

string

terms_discount_percent

string

order_id

integer

customer_order_number

string

purchase_order_number

string

status

enum<string>

remit_to

object

type

enum<string>

name1

string

name2

string

street1

string

street2

string

city

string

province

string

postal_code

string

country

string

phone1

string

phone2

string

fax

string

federal_tax_id

string

ship_from

object

type

enum<string>

name1

string

name2

string

street1

string

street2

string

city

string

province

string

postal_code

string

country

string

phone1

string

phone2

string

fax

string

federal_tax_id

string

sold_to

object

type

enum<string>

name1

string

name2

string

street1

string

street2

string

city

string

province

string

postal_code

string

country

string

phone1

string

phone2

string

fax

string

federal_tax_id

string

ship_to

object

type

enum<string>

name1

string

name2

string

street1

string

street2

string

city

string

province

string

postal_code

string

country

string

phone1

string

phone2

string

fax

string

federal_tax_id

string

shipping_carrier_name

string

shipping_carrier_code

string

shipping_account_number

string

shipping_method_name

string

shipping_method_code

string

shipping_tracking_number

string

shipping_weight

string

notes

string

invoiced_at

string

ordered_at

string

shipped_at

string

acknowledged_at

string

paid_at

string

closed_at

string

canceled_at

string

allowances

array

charges

array

net_amount

string

due_amount

string

expected_due_amount

string

subtotal

string

tax

string

invoice_acceptance

object

accepted_by

object

first_name

string

last_name

string

title

string

status

enum<string>

type

enum<string>

rejected_by

object

first_name

string

last_name

string

title

string

status

enum<string>

type

enum<string>

reject_reason

string

accepted_at

string

rejected_at

string

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

integer

required

Invoice ID

retailer_pk

number

required

Retailer ID

Body

application/json

invoice_number

string

required

Invoice number

Required string length: 1 - 32

retailer

object

brand

object

currency

object

terms_type

enum<string> | null

Types of invoice terms

Available options:

End of Month (EOM),

No Charge,

Consignment,

10 Days After End of Month (10 EOM),

Cash Discount Terms Apply,

Basic,

Fixed Date, Late Payment Penalty Applies,

Extended,

Discount Not Applicable,

Fixed Date,

Previously agreed upon

terms_description

string | null

Description of invoice terms

terms_net_days_due

integer | null

Number of days to pay invoice

Required range: -2147483648 < x < 2147483647

terms_date_due

string | null

Payment expected date

terms_discount_percent

string | null

Discount percentage on selected term

order_id

integer

Order ID related to invoice

customer_order_number

string | null

Customer order number (for enduser)

Maximum length: 64

purchase_order_number

string | null

Purchase order number (for retailer)

Maximum length: 64

status

enum<string>

Invoice status

Available options:

closed,

open

remit_to

object

ship_from

object

sold_to

object

ship_to

object

shipping_carrier_name

string | null

Name of shipping carrier

Maximum length: 32

shipping_carrier_code

string | null

Code of shipping carrier

Maximum length: 32

shipping_account_number

string | null

Shipping account number

Maximum length: 32

shipping_method_name

string | null

Name of shipping method

Maximum length: 32

shipping_method_code

string | null

Code of shipping method

Maximum length: 32

shipping_tracking_number

string | null

Shipping tracking number

Maximum length: 32

shipping_weight

string | null

Shipping weight

notes

string | null

Addition info adding to shipping

invoiced_at

string | null

Time of invoice creation (UTC format)

ordered_at

string | null

Time of order finalization (UTC format)

shipped_at

string | null

Time of shipping (UTC format)

acknowledged_at

string | null

Time of retailer acknowledgement (UTC format)

paid_at

string | null

Time of payment (UTC format)

closed_at

string | null

Time of complete invoice payment (UTC format)

canceled_at

string | null

Time of order cancellation (UTC format)

allowances

object[]

charges

object[]

net_amount

string | null

Total invoice amount (exluding taxes)

due_amount

string | null

Pending amount

expected_due_amount

string | null

Expected due amount (excluding allowances and charges)

subtotal

string | null

Sub-total

tax

string | null

Total tax on the invoice

invoice_acceptance

object

Response

200 - application/json

invoice_number

string

required

Invoice number

Required string length: 1 - 32

integer

Invoice ID

retailer

object

brand

object

connection_id

string

Connection ID

currency

object

terms_type

enum<string> | null

Types of invoice terms

Available options:

End of Month (EOM),

No Charge,

Consignment,

10 Days After End of Month (10 EOM),

Cash Discount Terms Apply,

Basic,

Fixed Date, Late Payment Penalty Applies,

Extended,

Discount Not Applicable,

Fixed Date,

Previously agreed upon

terms_description

string | null

Description of invoice terms

terms_net_days_due

integer | null

Number of days to pay invoice

Required range: -2147483648 < x < 2147483647

terms_date_due

string | null

Payment expected date

terms_discount_percent

string | null

Discount percentage on selected term

order_id

integer

Order ID related to invoice

customer_order_number

string | null

Customer order number (for enduser)

Maximum length: 64

purchase_order_number

string | null

Purchase order number (for retailer)

Maximum length: 64

status

enum<string>

Invoice status

Available options:

closed,

open

remit_to

object

ship_from

object

sold_to

object

ship_to

object

shipping_carrier_name

string | null

Name of shipping carrier

Maximum length: 32

shipping_carrier_code

string | null

Code of shipping carrier

Maximum length: 32

shipping_account_number

string | null

Shipping account number

Maximum length: 32

shipping_method_name

string | null

Name of shipping method

Maximum length: 32

shipping_method_code

string | null

Code of shipping method

Maximum length: 32

shipping_tracking_number

string | null

Shipping tracking number

Maximum length: 32

shipping_weight

string | null

Shipping weight

notes

string | null

Addition info adding to shipping

invoiced_at

string | null

Time of invoice creation (UTC format)

ordered_at

string | null

Time of order finalization (UTC format)

shipped_at

string | null

Time of shipping (UTC format)

acknowledged_at

string | null

Time of retailer acknowledgement (UTC format)

paid_at

string | null

Time of payment (UTC format)

closed_at

string | null

Time of complete invoice payment (UTC format)

canceled_at

string | null

Time of order cancellation (UTC format)

allowances

object[]

charges

object[]

invoice_lines

object[]

net_amount

string | null

Total invoice amount (exluding taxes)

due_amount

string | null

Pending amount

expected_due_amount

string | null

Expected due amount (excluding allowances and charges)

subtotal

string | null

Sub-total

tax

string | null

Total tax on the invoice

invoice_acceptance

object

Was this page helpful?

Get single product details List invocies from vendors