Charge

Uploaded Charge object

Field Name
Related Column
Data Type
Description

externalIds.vendor

Entry ID

string

Represents a unique vendor entry ID. Example: 2876850566

externalIds.reference

External Reference

string

Optional vendor-specific data, which might be used, for example, to detect the Marketplace order ID.

Example: ORD-3270-2860-5617

externalIds.invoice

Vendor Invoice Reference

string

Represents the vendor-specific invoice ID.

Example: 1234567890

search.subscription.criteria

Subscription Search Criteria

string

The search criteria for the specified subscription.

Example: subscription.externalIds.vendor

search.subscription.value

Subscription Search Value

string

The value of the subscription. Example: d77f96aec94563b671697ed752f81cNA

search.order.criteria

Order Search Criteria

string

The search criteria for the order.

Example: order.id

search.order.value

Order Search Value

string

The value of the order. Example: ORD-3270-2860-5617

search.item.criteria

Item Search Criteria

string

The search criteria for the item.

Example: item.externalIds.vendor

search.item.value

Item Search Value

string

The value of the item. Example: 30005387CA

period.start

Usage Start Time

Represents the start time of the entry.

Example: 2025-01-01T00:00:00Z

period.end

Usage End Time

Represents the end time for the entry.

Example: 2025-01-01T00:00:00Z

quantity

Quantity

decimal

The quantity of the entry.

Example: 10

price.unitPP

Purchase Price

decimal

The purchase price of the entry. Example: 253.83

price.PPx1

Total Purchase Price

decimal

The total purchase price of the entry.

Example: 2538.3

segment

Market Segment

string

Examples: COM, GOV, EDU

description.value1

Description1

string

Vendor-specific line 1 of the data.

description.value2

Description2

string

Vendor-specific line 2 of the data.

Journal Charge

Field Name
Data Type
Description

id

string

The ID of the charge.

Example: CHG-1234-1234-1234-1234-1234

status

enum

Allowed values: ready or error.

type

enum

Allowed values: automated or manual.

parent

charge

Optional reference to the parent charge for split billing cases, includes one parent split for the number of children charges.

Example:

buyer

object

A reference to the buyer object.

Example:

seller

object

A reference to the seller object.

Example:

ledger

object

A reference to the ledger object.

Example:

statement

object

A reference to the statement object.

Example:

licensee

object

A reference to the licensee object.

Example:

agreement

object

A reference to the agreement object.

Example:

subscription

object

A reference to the subscription object.

Example:

item

object

A reference to the item object.

Example:

authorization

object

A reference to the authorization object.

Example:

vendor

object

A reference to the vendor account object.

Example:

price

price

Example:

erpData

object

ERP system related data.

Example:

attributes

object

Various attributes taken from the input file.

Example:

Examples

Last updated

Was this helpful?