Get details of a single invoice

Gets details of a single invoice

Authorizations

Authorization

string

header

required

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

Path Parameters

id

integer

required

Invoice ID

retailer_pk

number

required

Retailer ID

Response

200 - application/json

invoice_number

string

required

Invoice number

Required string length: 1 - 32

acknowledged_at

string | null

Time of retailer acknowledgement (UTC format)

allowances

object[]

Show child attributes

allowances.description

string

required

Description of allowance

Required string length: 1 - 128

allowances.price

string

required

Allowance price

allowances.adjustment_code

object

Show child attributes

allowances.adjustment_code.adjustment_type

enum<string>

required

Adjustment type

Available options:

allowance,

charge

allowances.adjustment_code.code

string

required

Adjustment code

Required string length: 1 - 64

allowances.adjustment_code.description

string

required

Description of adjustment

Required string length: 1 - 128

allowances.adjustment_code.id

integer

Adjustment ID

allowances.id

integer

Allowance ID

brand

object

Show child attributes

brand.code

string

required

Vendor code, which is vendor name in lower case and underscore

Required string length: 1 - 64

brand.cover_url

string

URL of the cover image

Minimum length: 1

brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

brand.id

integer

Vendor (brand) ID

brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

brand.joined_at

string

Time when vendor joined Dropship (UTC format)

brand.logo_url

string

URL of the brand logo

Minimum length: 1

brand.name

string

Vendor name

Required string length: 1 - 64

brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

brand.website

string | null

URL of brand website

Maximum length: 100

canceled_at

string | null

Time of order cancellation (UTC format)

charges

object[]

Show child attributes

charges.description

string

required

Invoice description

Required string length: 1 - 128

charges.price

string

required

Invoice price

charges.adjustment_code

object

Show child attributes

charges.adjustment_code.adjustment_type

enum<string>

required

Adjustment type

Available options:

allowance,

charge

charges.adjustment_code.code

string

required

Adjustment code

Required string length: 1 - 64

charges.adjustment_code.description

string

required

Description of adjustment

Required string length: 1 - 128

charges.adjustment_code.id

integer

Adjustment ID

charges.id

integer

Invoice ID

closed_at

string | null

Time of complete invoice payment (UTC format)

connection_id

string

Connection ID

currency

object

Show child attributes

currency.id

integer

Currency ID

currency.name

string

Currency name

Maximum length: 200

currency.symbol

string | null

Currency symbol

Maximum length: 5

currency.unit

string

Currency unit

customer_order_number

string | null

Customer order number (for enduser)

Maximum length: 64

due_amount

string | null

Pending amount

expected_due_amount

string | null

Expected due amount (excluding allowances and charges)

id

integer

Invoice ID

invoice_acceptance

object

Show child attributes

invoice_acceptance.accepted_at

string | null

Time of invoice acceptance (UTC format)

invoice_acceptance.accepted_by

object

Vendor acceptanc

Show child attributes

invoice_acceptance.accepted_by.first_name

string | null

First name of user

Maximum length: 64

invoice_acceptance.accepted_by.id

integer

User ID who accepted or rejected the invoice

invoice_acceptance.accepted_by.is_me

boolean

true: user is me: <br /> false: user is not me

invoice_acceptance.accepted_by.last_name

string | null

Last name of user

Maximum length: 64

invoice_acceptance.accepted_by.photo_url

string

URL of the user photo

Minimum length: 1

invoice_acceptance.accepted_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

invoice_acceptance.accepted_by.status

enum<string>

User status

Available options:

active,

invited,

locked

invoice_acceptance.accepted_by.title

string | null

User title

Maximum length: 64

invoice_acceptance.accepted_by.type

enum<string>

User type

Available options:

standard,

api

invoice_acceptance.id

integer

Invoice acceptance ID

invoice_acceptance.reject_reason

string | null

Reason for invoice rejection

Maximum length: 128

invoice_acceptance.rejected_at

string | null

Time of invoice rejection (UTC format)

invoice_acceptance.rejected_by

object

Show child attributes

invoice_acceptance.rejected_by.first_name

string | null

First name of user

Maximum length: 64

invoice_acceptance.rejected_by.id

integer

User ID who accepted or rejected the invoice

invoice_acceptance.rejected_by.is_me

boolean

true: user is me: <br /> false: user is not me

invoice_acceptance.rejected_by.last_name

string | null

Last name of user

Maximum length: 64

invoice_acceptance.rejected_by.photo_url

string

URL of the user photo

Minimum length: 1

invoice_acceptance.rejected_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

invoice_acceptance.rejected_by.status

enum<string>

User status

Available options:

active,

invited,

locked

invoice_acceptance.rejected_by.title

string | null

User title

Maximum length: 64

invoice_acceptance.rejected_by.type

enum<string>

User type

Available options:

standard,

api

invoice_lines

object[]

Show child attributes

invoice_lines.price

string

required

Discounted price

invoice_lines.quantity

integer

required

Product quantity

Required range: -2147483648 < x < 2147483647

invoice_lines.canceled_at

string | null

Time of cancellation (UTC format)

invoice_lines.description

string | null

Product description

Maximum length: 128

invoice_lines.id

integer

Invoice line ID

invoice_lines.invoice_line_number

integer | null

Invoice line number

Required range: -2147483648 < x < 2147483647

invoice_lines.item_brand_identifier

string | null

Vendor identifier of product

Maximum length: 128

invoice_lines.item_upc

string | null

Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in your dropshipping store

Maximum length: 32

invoice_lines.name

string | null

Product name

Maximum length: 128

invoice_lines.retail_price

string

Retail price

invoice_lines.variant

object

Show child attributes

invoice_lines.variant.active_permit

object

Show child attributes

invoice_lines.variant.active_permit.acknowledged_at

string | null

Time of acknowledgement (UTC format)

invoice_lines.variant.active_permit.attributes

object

invoice_lines.variant.active_permit.end_at

string | null

Time of permit end (UTC format)

invoice_lines.variant.active_permit.id

integer

Permit ID

invoice_lines.variant.active_permit.is_acknowledged

boolean

true: permit is acknowledged <br /> false: permit is not acknowledged

invoice_lines.variant.active_permit.is_in_effect

boolean

true: permit is in effect <br /> false: permit is not in effect

invoice_lines.variant.active_permit.pricing

object

invoice_lines.variant.active_permit.retailer

object

Show child attributes

invoice_lines.variant.active_permit.retailer.code

string

required

Retailer code, which is retailer name in lower case and hyphenated

Required string length: 1 - 32

invoice_lines.variant.active_permit.retailer.name

string

required

Retailer name

Required string length: 1 - 64

invoice_lines.variant.active_permit.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

invoice_lines.variant.active_permit.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

invoice_lines.variant.active_permit.retailer.id

integer

Retailer ID

invoice_lines.variant.active_permit.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

invoice_lines.variant.active_permit.retailer.is_rcn_retailer

boolean

true: Retailer is in Dropship network; Retailer is not in Dropship network

invoice_lines.variant.active_permit.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

invoice_lines.variant.active_permit.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

invoice_lines.variant.active_permit.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

invoice_lines.variant.active_permit.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

invoice_lines.variant.active_permit.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

invoice_lines.variant.active_permit.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

invoice_lines.variant.active_permit.retailer.website

string | null

Website URL

Maximum length: 100

invoice_lines.variant.active_permit.retailer_cost

string | null

Retailer cost of variant

invoice_lines.variant.active_permit.retailer_price

string | null

Retailer price of the variant

invoice_lines.variant.active_permit.revoked_at

string | null

Time when permit got revoked (UTC format)

invoice_lines.variant.active_permit.start_at

string | null

Time of permit start (UTC format)

invoice_lines.variant.attributes

object[]

Show child attributes

invoice_lines.variant.attributes.code

string

required

Attribute code

Required string length: 1 - 200

invoice_lines.variant.attributes.name

string

required

Attribute name

Required string length: 1 - 200

invoice_lines.variant.attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

invoice_lines.variant.attributes.description

string | null

Attribute description

invoice_lines.variant.attributes.editable_by

enum<string> | null

User permission to edit attribute

Available options:

retailer,

brand,

any,

none

invoice_lines.variant.attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

invoice_lines.variant.attributes.id

integer

Attribute ID

invoice_lines.variant.attributes.units

string | null

Unit of the selected attribute type. If the attribute type is money, the unit is USD.

Maximum length: 32

invoice_lines.variant.attributes.values

object

Show child attributes

invoice_lines.variant.attributes.values.created_at

string

Time of creation

invoice_lines.variant.attributes.values.id

integer

Attribute value ID

invoice_lines.variant.attributes.values.retailer

object

Show child attributes

invoice_lines.variant.attributes.values.unit

object

Show child attributes

invoice_lines.variant.attributes.values.updated_at

string

Time of update

invoice_lines.variant.attributes.values.value

string

Attribute value

invoice_lines.variant.brand

object

Show child attributes

invoice_lines.variant.brand.code

string

required

Vendor code, which is vendor name in lower case and underscore

Required string length: 1 - 64

invoice_lines.variant.brand.cover_url

string

URL of the cover image

Minimum length: 1

invoice_lines.variant.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

invoice_lines.variant.brand.id

integer

Vendor (brand) ID

invoice_lines.variant.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

invoice_lines.variant.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

invoice_lines.variant.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

invoice_lines.variant.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

invoice_lines.variant.brand.logo_url

string

URL of the brand logo

Minimum length: 1

invoice_lines.variant.brand.name

string

Vendor name

Required string length: 1 - 64

invoice_lines.variant.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

invoice_lines.variant.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

invoice_lines.variant.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

invoice_lines.variant.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

invoice_lines.variant.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

invoice_lines.variant.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

invoice_lines.variant.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

invoice_lines.variant.brand.website

string | null

URL of brand website

Maximum length: 100

invoice_lines.variant.brand_identifier

string

Unique SKU assigned by the Brand

Minimum length: 1

invoice_lines.variant.cartons

object[]

Show child attributes

invoice_lines.variant.cartons.height

string | null

Carton height

invoice_lines.variant.cartons.height_unit

string

Unit of height

invoice_lines.variant.cartons.id

integer

Carton ID

invoice_lines.variant.cartons.length

string | null

Carton length

invoice_lines.variant.cartons.length_unit

string

Unit of length

invoice_lines.variant.cartons.number

integer

Carton number

Required range: -2147483648 < x < 2147483647

invoice_lines.variant.cartons.package_girth_inches

string

Girth of the package, in inches

invoice_lines.variant.cartons.package_size_inches

string

Size of the package, in inches

invoice_lines.variant.cartons.weight

string | null

Carton weight

invoice_lines.variant.cartons.weight_unit

string

Unit of weight

invoice_lines.variant.cartons.width

string | null

Carton width

invoice_lines.variant.cartons.width_unit

string

Unit of width

invoice_lines.variant.color

string | null

Color of the item (from attributes.color)

Maximum length: 128

invoice_lines.variant.id

integer

Variant ID

invoice_lines.variant.identifier

string | null

Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.

Maximum length: 128

invoice_lines.variant.inventory

object

Show child attributes

invoice_lines.variant.inventory.brand_inventory_updated_at

string

required

Time of vendor inventory update (UTC format)

invoice_lines.variant.inventory.estimated_availability_date

string

required

Estimated delivery date (UTC format)

Minimum length: 1

invoice_lines.variant.inventory.inventory_last_submitted_at

string

required

Time of inventory submit (UTC format)

invoice_lines.variant.inventory.inventory_updated_at

string

required

Time of inventory update (UTC format)

invoice_lines.variant.inventory.sellable_updated_at

string

required

Time when product or variant was marked sellable (UTC format)

invoice_lines.variant.inventory.discontinued

boolean

true: Product is discontinued <br /> false: Product is active

invoice_lines.variant.inventory.discontinued_updated_at

string

Time of when product inventory was discontinued (UTC format)

invoice_lines.variant.inventory.inventory

integer

Inventory of variant

invoice_lines.variant.inventory.locations

object[]

Show child attributes

invoice_lines.variant.inventory.locations.address

object

Show child attributes

invoice_lines.variant.inventory.locations.id

integer

Location ID

invoice_lines.variant.inventory.locations.inventory

integer

Count of sellable variants

invoice_lines.variant.inventory.locations.nickname

string

Nickname of location

invoice_lines.variant.inventory.replenishable

boolean

true: product is replenishable <br /> false: product is not replenishable

invoice_lines.variant.inventory.sellable

string

yes: Variant is sellable <br /> No: Variant is not sellable

invoice_lines.variant.is_compatible

boolean

true: variant meets requirement <br /> false: variant doesn not meet requirement

invoice_lines.variant.media

object[]

Show child attributes

invoice_lines.variant.media.created_at

string

Time of variant image creation (UTC format)

invoice_lines.variant.media.height

integer | null

Height of variant image

Required range: -2147483648 < x < 2147483647

invoice_lines.variant.media.id

integer

Variant ID

invoice_lines.variant.media.media

string

Variant images

invoice_lines.variant.media.priority

integer

Order in which the vendor prefers the images to be shown image 1 is shown first.

Required range: -2147483648 < x < 2147483647

invoice_lines.variant.media.updated_at

string

Time of variant image update (UTC format)

invoice_lines.variant.media.url

string

URL of variant image

invoice_lines.variant.media.width

integer | null

Width of variant image

Required range: -2147483648 < x < 2147483647

invoice_lines.variant.name

string | null

Variant Name

Maximum length: 200

invoice_lines.variant.permits

object[]

Show child attributes

invoice_lines.variant.permits.acknowledged_at

string | null

Time of acknowledgement (UTC format)

invoice_lines.variant.permits.attributes

object

invoice_lines.variant.permits.end_at

string | null

Time of permit end (UTC format)

invoice_lines.variant.permits.id

integer

Permit ID

invoice_lines.variant.permits.is_acknowledged

boolean

true: permit is acknowledged <br /> false: permit is not acknowledged

invoice_lines.variant.permits.is_in_effect

boolean

true: permit is in effect <br /> false: permit is not in effect

invoice_lines.variant.permits.pricing

object

invoice_lines.variant.permits.retailer

object

Show child attributes

invoice_lines.variant.permits.retailer.code

string

required

Retailer code, which is retailer name in lower case and hyphenated

Required string length: 1 - 32

invoice_lines.variant.permits.retailer.name

string

required

Retailer name

Required string length: 1 - 64

invoice_lines.variant.permits.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

invoice_lines.variant.permits.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

invoice_lines.variant.permits.retailer.id

integer

Retailer ID

invoice_lines.variant.permits.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

invoice_lines.variant.permits.retailer.is_rcn_retailer

boolean

true: Retailer is in Dropship network; Retailer is not in Dropship network

invoice_lines.variant.permits.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

invoice_lines.variant.permits.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

invoice_lines.variant.permits.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

invoice_lines.variant.permits.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

invoice_lines.variant.permits.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

invoice_lines.variant.permits.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

invoice_lines.variant.permits.retailer.website

string | null

Website URL

Maximum length: 100

invoice_lines.variant.permits.retailer_cost

string | null

Retailer cost of variant

invoice_lines.variant.permits.retailer_price

string | null

Retailer price of the variant

invoice_lines.variant.permits.revoked_at

string | null

Time when permit got revoked (UTC format)

invoice_lines.variant.permits.start_at

string | null

Time of permit start (UTC format)

invoice_lines.variant.proposal_variant

object

Show child attributes

invoice_lines.variant.proposal_variant.approve

boolean

true: proposal is approved <br /> false: proposal is not approved

invoice_lines.variant.proposal_variant.approved_at

string | null

Time of approval (UTC format)

invoice_lines.variant.proposal_variant.attributes

object[]

Show child attributes

invoice_lines.variant.proposal_variant.attributes.created_at

string

Time of creation

invoice_lines.variant.proposal_variant.attributes.id

integer

Attribute value ID

invoice_lines.variant.proposal_variant.attributes.retailer

object

Show child attributes

invoice_lines.variant.proposal_variant.attributes.unit

object

Show child attributes

invoice_lines.variant.proposal_variant.attributes.updated_at

string

Time of update

invoice_lines.variant.proposal_variant.attributes.value

string

Attribute value

invoice_lines.variant.proposal_variant.created_at

string

Time of creation (UTC format)

invoice_lines.variant.proposal_variant.delete

boolean

true: proposal is deleted <br /> false: proposal is not deleted

invoice_lines.variant.proposal_variant.id

integer

Proposal variant ID

invoice_lines.variant.proposal_variant.issues

object[]

Show child attributes

invoice_lines.variant.proposal_variant.issues.created_at

string

Time of issue creation

invoice_lines.variant.proposal_variant.issues.id

integer

Issue ID

invoice_lines.variant.proposal_variant.issues.is_resolved

string

true: Issue is resolved <br /> false: Issue is not resolved

invoice_lines.variant.proposal_variant.issues.issue_id

integer

Issue ID

invoice_lines.variant.proposal_variant.issues.memos

object[]

Show child attributes

invoice_lines.variant.proposal_variant.issues.message

string

Description or note related to issue

Minimum length: 1

invoice_lines.variant.proposal_variant.issues.resolved_at

string

Time of issue resolution

invoice_lines.variant.proposal_variant.issues.title

string

Issue title

Minimum length: 1

invoice_lines.variant.proposal_variant.issues.updated_at

string

Time of issue update

invoice_lines.variant.proposal_variant.memos

object[]

Show child attributes

invoice_lines.variant.proposal_variant.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

invoice_lines.variant.proposal_variant.memos.created_at

string

Time of memo creation (UTC format)

invoice_lines.variant.proposal_variant.memos.created_by

object

Show child attributes

invoice_lines.variant.proposal_variant.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

invoice_lines.variant.proposal_variant.memos.id

integer

Memo ID

invoice_lines.variant.proposal_variant.memos.notify_people

boolean

true: notify stakeholders <br /> false: do not notify

invoice_lines.variant.proposal_variant.memos.text

string

Memo text

invoice_lines.variant.proposal_variant.memos.updated_at

string

Time of memo update (UTC format)

invoice_lines.variant.proposal_variant.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

invoice_lines.variant.proposal_variant.pricing

string

Pricing of variant

invoice_lines.variant.proposal_variant.reject

boolean

true: proposal is rejected <br /> false: proposal is not rejected

invoice_lines.variant.proposal_variant.reject_reason

string | null

Rejection reason

Maximum length: 32

invoice_lines.variant.proposal_variant.rejected_at

string | null

Time of proposal rejection (UTC format)

invoice_lines.variant.proposal_variant.updated_at

string

Time of last update (UTC format)

invoice_lines.variant.proposal_variant.variant_id

integer

Variant ID

invoice_lines.variant.retailer_categories

object

Show child attributes

invoice_lines.variant.retailer_categories.category

string

required

Category name

Required string length: 1 - 256

invoice_lines.variant.retailer_categories.id

integer

Retailer category ID

invoice_lines.variant.retailer_categories.retailer

object

Show child attributes

invoice_lines.variant.retailer_categories.retailer.code

string

required

Retailer code, which is retailer name in lower case and hyphenated

Required string length: 1 - 32

invoice_lines.variant.retailer_categories.retailer.name

string

required

Retailer name

Required string length: 1 - 64

invoice_lines.variant.retailer_categories.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

invoice_lines.variant.retailer_categories.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

invoice_lines.variant.retailer_categories.retailer.id

integer

Retailer ID

invoice_lines.variant.retailer_categories.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

invoice_lines.variant.retailer_categories.retailer.is_rcn_retailer

boolean

true: Retailer is in Dropship network; Retailer is not in Dropship network

invoice_lines.variant.retailer_categories.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

invoice_lines.variant.retailer_categories.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

invoice_lines.variant.retailer_categories.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

invoice_lines.variant.retailer_categories.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

invoice_lines.variant.retailer_categories.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

invoice_lines.variant.retailer_categories.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

invoice_lines.variant.retailer_categories.retailer.website

string | null

Website URL

Maximum length: 100

invoice_lines.variant.retailer_identifiers

object

Show child attributes

invoice_lines.variant.retailer_identifiers.id

integer

Retailer ID

invoice_lines.variant.retailer_identifiers.identifier

string | null

Stock Keeping Unit (SKU), unique identifier of a product

Maximum length: 256

invoice_lines.variant.retailer_identifiers.name

string | null

Retailer name

Maximum length: 256

invoice_lines.variant.retailer_identifiers.retailer

object

Show child attributes

invoice_lines.variant.retailer_identifiers.retailer.code

string

required

Retailer code, which is retailer name in lower case and hyphenated

Required string length: 1 - 32

invoice_lines.variant.retailer_identifiers.retailer.name

string

required

Retailer name

Required string length: 1 - 64

invoice_lines.variant.retailer_identifiers.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

invoice_lines.variant.retailer_identifiers.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

invoice_lines.variant.retailer_identifiers.retailer.id

integer

Retailer ID

invoice_lines.variant.retailer_identifiers.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

invoice_lines.variant.retailer_identifiers.retailer.is_rcn_retailer

boolean

true: Retailer is in Dropship network; Retailer is not in Dropship network

invoice_lines.variant.retailer_identifiers.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

invoice_lines.variant.retailer_identifiers.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

invoice_lines.variant.retailer_identifiers.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

invoice_lines.variant.retailer_identifiers.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

invoice_lines.variant.retailer_identifiers.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

invoice_lines.variant.retailer_identifiers.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

invoice_lines.variant.retailer_identifiers.retailer.website

string | null

Website URL

Maximum length: 100

invoice_lines.variant.ruleset_variant_summary

string

Number of items that are passed and failed in rule validation.

invoice_lines.variant.ruleset_variants

object[]

Show child attributes

invoice_lines.variant.ruleset_variants.created_at

string

Time of creation (UTC format)

invoice_lines.variant.ruleset_variants.id

integer

ID of ruleset variant

invoice_lines.variant.ruleset_variants.results

string

Response

invoice_lines.variant.ruleset_variants.ruleset

object

Show child attributes

invoice_lines.variant.ruleset_variants.ruleset.created_at

string

Time of creation (UTC format)

invoice_lines.variant.ruleset_variants.ruleset.id

integer

ID of ruleset variant

invoice_lines.variant.ruleset_variants.ruleset.results

string

Response

invoice_lines.variant.ruleset_variants.ruleset.ruleset

object

Show child attributes

invoice_lines.variant.ruleset_variants.ruleset.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

invoice_lines.variant.ruleset_variants.ruleset.updated_at

string

Time of last update (UTC format)

invoice_lines.variant.ruleset_variants.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

invoice_lines.variant.ruleset_variants.updated_at

string

Time of last update (UTC format)

invoice_lines.variant.size

string | null

Size of the item (will be the same value as attributes.size)

Maximum length: 128

invoice_lines.variant.style

string | null

Style of the item (will be the same value as attributes.style)

Maximum length: 128

invoice_lines.variant.upc

string

UPC or other GTIN

Maximum length: 64

invoiced_at

string | null

Time of invoice creation (UTC format)

net_amount

string | null

Total invoice amount (exluding taxes)

notes

string | null

Addition info adding to shipping

order_id

integer

Order ID related to invoice

ordered_at

string | null

Time of order finalization (UTC format)

paid_at

string | null

Time of payment (UTC format)

purchase_order_number

string | null

Purchase order number (for retailer)

Maximum length: 64

remit_to

object

Show child attributes

remit_to.city

string

required

City name

Required string length: 1 - 64

remit_to.country

string

required

Country name

Required string length: 1 - 128

remit_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

remit_to.postal_code

string

required

Postal code

Required string length: 1 - 32

remit_to.province

string

required

State name

Required string length: 1 - 32

remit_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

remit_to.email

string | null

Contact email address

Maximum length: 128

remit_to.fax

string | null

Fax number

Maximum length: 32

remit_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

remit_to.id

integer

Address ID

remit_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

remit_to.phone1

string | null

Primary contact number

Maximum length: 32

remit_to.phone2

string | null

Alternate contact number

Maximum length: 32

remit_to.street2

string | null

Line 2 of the address

Maximum length: 128

remit_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

retailer

object

Show child attributes

retailer.code

string

required

Retailer code, which is retailer name in lower case and hyphenated

Required string length: 1 - 32

retailer.name

string

required

Retailer name

Required string length: 1 - 64

retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

retailer.id

integer

Retailer ID

retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

retailer.is_rcn_retailer

boolean

true: Retailer is in Dropship network; Retailer is not in Dropship network

retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

retailer.logo_url

string

URL of retailer logo

Minimum length: 1

retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

retailer.website

string | null

Website URL

Maximum length: 100

ship_from

object

Show child attributes

ship_from.city

string

required

City name

Required string length: 1 - 64

ship_from.country

string

required

Country name

Required string length: 1 - 128

ship_from.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

ship_from.postal_code

string

required

Postal code

Required string length: 1 - 32

ship_from.province

string

required

State name

Required string length: 1 - 32

ship_from.street1

string

required

Line 1 of the address

Required string length: 1 - 128

ship_from.email

string | null

Contact email address

Maximum length: 128

ship_from.fax

string | null

Fax number

Maximum length: 32

ship_from.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

ship_from.id

integer

Address ID

ship_from.name2

string | null

Name of the alternative contact?

Maximum length: 64

ship_from.phone1

string | null

Primary contact number

Maximum length: 32

ship_from.phone2

string | null

Alternate contact number

Maximum length: 32

ship_from.street2

string | null

Line 2 of the address

Maximum length: 128

ship_from.type

enum<string> | null

Type of address

Available options:

residential,

commercial

ship_to

object

Show child attributes

ship_to.city

string

required

City name

Required string length: 1 - 64

ship_to.country

string

required

Country name

Required string length: 1 - 128

ship_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

ship_to.postal_code

string

required

Postal code

Required string length: 1 - 32

ship_to.province

string

required

State name

Required string length: 1 - 32

ship_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

ship_to.email

string | null

Contact email address

Maximum length: 128

ship_to.fax

string | null

Fax number

Maximum length: 32

ship_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

ship_to.id

integer

Address ID

ship_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

ship_to.phone1

string | null

Primary contact number

Maximum length: 32

ship_to.phone2

string | null

Alternate contact number

Maximum length: 32

ship_to.street2

string | null

Line 2 of the address

Maximum length: 128

ship_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

shipped_at

string | null

Time of shipping (UTC format)

shipping_account_number

string | null

Shipping account number

Maximum length: 32

shipping_carrier_code

string | null

Code of shipping carrier

Maximum length: 32

shipping_carrier_name

string | null

Name of shipping carrier

Maximum length: 32

shipping_method_code

string | null

Code of shipping method

Maximum length: 32

shipping_method_name

string | null

Name of shipping method

Maximum length: 32

shipping_tracking_number

string | null

Shipping tracking number

Maximum length: 32

shipping_weight

string | null

Shipping weight

sold_to

object

Show child attributes

sold_to.city

string

required

City name

Required string length: 1 - 64

sold_to.country

string

required

Country name

Required string length: 1 - 128

sold_to.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

sold_to.postal_code

string

required

Postal code

Required string length: 1 - 32

sold_to.province

string

required

State name

Required string length: 1 - 32

sold_to.street1

string

required

Line 1 of the address

Required string length: 1 - 128

sold_to.email

string | null

Contact email address

Maximum length: 128

sold_to.fax

string | null

Fax number

Maximum length: 32

sold_to.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

sold_to.id

integer

Address ID

sold_to.name2

string | null

Name of the alternative contact?

Maximum length: 64

sold_to.phone1

string | null

Primary contact number

Maximum length: 32

sold_to.phone2

string | null

Alternate contact number

Maximum length: 32

sold_to.street2

string | null

Line 2 of the address

Maximum length: 128

sold_to.type

enum<string> | null

Type of address

Available options:

residential,

commercial

status

enum<string>

Invoice status

Available options:

closed,

open

subtotal

string | null

Sub-total

tax

string | null

Total tax on the invoice

terms_date_due

string | null

Payment expected date

terms_description

string | null

Description of invoice terms

terms_discount_percent

string | null

Discount percentage on selected term

terms_net_days_due

integer | null

Number of days to pay invoice

Required range: -2147483648 < x < 2147483647

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