Charge

Uploaded Charge

Field

XLSX Column

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

Type

Description

string

The ID of the charge.

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

status

enum

Possible values: Ready or Error

type

enum

Possible 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:

{
  "id": "CHG-1234-1234-1234-1234-1234"
}

buyer

A reference to the Buyer object.

Example:

{
  "id": "BUY-0355-0939",
  "href": "/accounts/buyers/BUY-0355-0939",
  "name": "TEST_BUYER30_rec"
}

seller

A reference to the Seller object.

Example:

{
  "id": "SEL-9512-0354",
  "href": "/accounts/sellers/SEL-9512-0354",
  "name": "TEST_SELLER30_rec"
}

ledger

A reference to the Ledger object.

Example:

{
  "id": "BLE-6084-5502-9512-0354"
}

statement

A reference to the Statement object.

Example:

{
  "id": "SOM-6084-5502-5163-5035-5953",
  "type": "Debit"
}

licensee

A reference to the Agreement object.

Example:

{
  "id": "LCE-4563-7526-8099",
  "href": "/accounts/licensees/LCE-4563-7526-8099",
  "name": "TEST_LICENSEE30_rec"
}

agreement

A reference to the Agreement object.

Example:

{
  "id": "AGR-5163-5035-5953",
  "href": "/commerce/agreements/AGR-5163-5035-5953",
  "status": "Active",
  "name": "TEST_AGREEMENT30_rec_1"
}

subscription

A reference to the Subscription object.

Example:

{
  "id": "SUB-7342-6318-2370",
  "href": "/commerce/subscriptions/SUB-7342-6318-2370",
  "name": "TEST_SUBSCRIPTION30_rec_1"
}

item

A reference to the Item object.

Example:

{
  "id": "ITM-5333-3116-0002",
  "href": "/items/ITM-5333-3116-0002",
  "name": "TEST_SUBSCRIPTIONITEM30_rec"
}

authorization

A reference to the Authorization object.

Example:

{
  "id": "AUT-2173-6546",
  "href": "/catalog/authorizations/AUT-2173-6546",
  "name": "MY_TEST_AUTHORIZATION30_rec"
}

vendor

A reference to the vendor Account object.

Example:

{
  "id": "ACC-3647-5309",
  "href": "/accounts/accounts/ACC-3647-5309",
  "name": "TEST_VENDOR30_rec"
}

price

price

Example:

{
    "unitPP": 92.09375679688615,
    "unitSP": 101.30313247657476,
    "PPx1": 184.1875135937723,
    "SPx1": 202.60626495314952
    "markup": 10,
    "margin": 9.0909090909
}

erpData

object

ERP system related data.

Example:

{
    "scu": "1",
    "cco": "ATC-CCO-112612",
    "erpItemId": "AO03.22961.MP"
}

attributes

object

Various attributes taken from the input file.

Example:

{
    "documentNumber": "AGR-0605-6606-7993",
    "orderType": "Direct",
    "externalDocumentNo": "4500776612",
    "externalDocumentNo2": "AGR-0605-6606-7993",
    "yourReference": "Adobe VIP Marketplace Prinzhorn Holding GmbH"
}

Examples

{
    "externalIds": {
      "vendor": "TEST_CHARGE_001"
      "reference": null,
      "invoice": "2000005957",
    },
    "search": {
      "subscription": {
        "criteria": "subscription.externalIds.vendor",
        "value": "86c4f6b8-ead5-4752-9075-1d2caec6a7cc"
      },
      "item": {
        "criteria": "item.externalIds.vendor",
        "value": "73927560-e5f2-4be4-bdb3-7f6069f0bf94"
      }
    },
    "period": {
      "start": "2025-01-01T00:00:00Z",
      "end": "2025-01-31T23:59:59Z"
    },
    "quantity": 2,
    "price": {
      "unitPP": 93.10961859011398,
      "PPx1": 186.21923718022796
    },
    "segment": "COM"
}

{
    "id": "CHG-6084-5502-0000-0000-0100",
    "type": "Automated",
    "externalIds": {
      "vendor": "TEST_CHARGE_001"
      "reference": null,
      "invoice": "2000005957",
    },
    "search": {
      "subscription": {
        "criteria": "subscription.externalIds.vendor",
        "value": "86c4f6b8-ead5-4752-9075-1d2caec6a7cc"
      },
      "item": {
        "criteria": "item.externalIds.vendor",
        "value": "73927560-e5f2-4be4-bdb3-7f6069f0bf94"
      }
    },
    "period": {
      "start": "2025-01-01T00:00:00Z",
      "end": "2025-01-31T23:59:59Z"
    },
    "quantity": 2,
    "segment": "COM",
    "ledger": {
      "id": "BLE-6084-5502-9512-0354"
    },
  "licensee": {
    "id": "LCE-4563-7526-8099",
    "href": "/accounts/licensees/LCE-4563-7526-8099",
    "name": "CHRISTINA_TEST_LICENSEE30_rec"
  },
  "product": {
    "id": "PRD-5333-3116",
    "href": "/catalog/products/PRD-5333-3116",
    "name": "CHRISTINA_TEST_PRODUCT30_rec",
    "icon": "/v1/catalog/products/PRD-5333-3116/icon"
  },
  "agreement": {
    "id": "AGR-5163-5035-5953",
    "href": "/commerce/agreements/AGR-5163-5035-5953",
    "status": "Active",
    "name": "CHRISTINA_TEST_AGREEMENT30_rec_1"
  },
  "subscription": {
    "id": "SUB-7342-6318-2370",
    "href": "/commerce/subscriptions/SUB-7342-6318-2370",
    "name": "CHRISTINA_TEST_SUBSCRIPTION30_rec_1"
  },
  "item": {
    "id": "ITM-5333-3116-0002",
    "href": "/items/ITM-5333-3116-0002",
    "name": "CHRISTINA_TEST_SUBSCRIPTIONITEM30_rec"
  },
  "authorization": {
    "id": "AUT-2173-6546",
    "href": "/catalog/authorizations/AUT-2173-6546",
    "name": "CHRISTINA_TEST_AUTHORIZATION30_rec"
  },
  "statement": {
    "id": "SOM-6084-5502-5163-5035-5953",
    "type": "Debit",
  },
  "startDate": "2025-01-01T00:00:00.000Z",
  "endDate": "2025-01-31T23:59:59.000Z",
  "client": {
    "id": "ACC-8119-0187",
    "href": "/accounts/accounts/ACC-8119-0187",
    "name": "CHRISTINA_TEST_CLIENT30_rec"
  },
  "buyer": {
    "id": "BUY-0355-0939",
    "href": "/accounts/buyers/BUY-0355-0939",
    "name": "CHRISTINA_TEST_BUYER30_rec"
  },
  "vendor": {
    "id": "ACC-3647-5309",
    "href": "/accounts/accounts/ACC-3647-5309",
    "name": "CHRISTINA_TEST_VENDOR30_rec"
  },
  "seller": {
    "id": "SEL-9512-0354",
    "href": "/accounts/sellers/SEL-9512-0354",
    "name": "CHRISTINA_TEST_SELLER30_rec"
  },
  "price": {
    "unitPP": 92.09375679688615,
    "totalPP": 184.1875135937723,
    "markup": 10,
    "margin": 9.0909090909,
    "unitSP": 101.30313247657476,
    "totalSP": 202.60626495314952
  }
}

PreviousBilling API NextList Journal Charges

Last updated 14 hours ago

Was this helpful?