Get Journal Charge

Retrieves a specific charge by its ID.

get

Path parameters

idstringRequired

The ID of the charge.

journalIdstringRequired

Query parameters

selectstringOptional

The select statement to filter the fields.

Responses

200

OK

application/json

Represents a charge in the billing system.

idstringOptional

The unique identifier of the charge.

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

quantitynumber · doubleOptional

Indicates the quantity associated with the charge.

Example: 10.5

billingTypeall ofRead-onlyOptional

Indicates the billing type of the charge, defaulting to automated.

Example: Automated

string · enumOptional

Represents the type of billing process.

Possible values:

statementTypeall ofOptional

Indicates the type of statement associated with the charge.

Example: Debit

string · enumOptional

Represents the type of a statement in the billing system.

Possible values:

404

Not Found

application/json

get

/public/v1/billing/journals/{journalId}/charges/{id}

HTTPcURLJavaScriptPython

GET /public/v1/billing/journals/{journalId}/charges/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

{
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "audit": {
    "reconciled": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "reset": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "id": "CHG-1234-1234-1234-1234-1234",
  "externalIds": {
    "reference": "REF-67890",
    "invoice": "INV-12345",
    "vendor": "VND-54321"
  },
  "search": {
    "source": {
      "criteria": "externalIds.Vendor",
      "value": "EXT-12345",
      "type": "Subscription"
    },
    "order": {
      "criteria": "externalIds.Vendor",
      "value": "EXT-12345"
    },
    "item": {
      "criteria": "externalIds.Vendor",
      "value": "EXT-12345"
    }
  },
  "period": {
    "start": "2025-01-01T00:00:00.0000000+00:00",
    "end": "2025-01-31T23:59:59.0000000+00:00"
  },
  "quantity": 10.5,
  "price": {
    "currency": {
      "purchase": "USD",
      "sale": "EUR",
      "rate": 1
    },
    "markup": 15.5,
    "markupSource": "Line",
    "margin": 20,
    "unitPP": 100,
    "PPx1": 1000,
    "unitSP": 120,
    "SPx1": 1200
  },
  "description": {
    "value1": "Monthly subscription charge",
    "value2": "Includes additional services"
  },
  "attributes": {
    "documentNumber": "DOC-12345",
    "orderType": "PurchaseOrder",
    "externalDocumentNo": "EXT-67890",
    "externalDocumentNo2": "EXT2-54321",
    "yourReference": "CUST-REF-001",
    "agreementVendorId": "170ec08e-f43c-4831-aeb2-0d6455e1acf5",
    "segment": "Segment-A"
  },
  "journal": {
    "id": "BJO-1234-1234",
    "name": "29 Nov 2024 #1",
    "dueDate": "2025-05-15T23:59:59.0000000+00:00"
  },
  "ledger": {
    "id": "BLE-1234-1234-1234-1234"
  },
  "customLedger": {
    "id": "text",
    "name": "Quarterly Revenue Ledger"
  },
  "parent": {
    "id": "CHG-1234-1234-1234-1234-1234",
    "externalIds": {
      "reference": "REF-67890",
      "invoice": "INV-12345",
      "vendor": "VND-54321"
    }
  },
  "billingType": "Automated",
  "upload": {
    "status": "Ready",
    "errors": [
      "Invalid charge amount",
      "Missing buyer information"
    ]
  },
  "licensee": {
    "id": "text",
    "icon": "text",
    "name": "text",
    "externalId": "text"
  },
  "agreement": {
    "id": "text",
    "icon": "text",
    "status": "text",
    "name": "text"
  },
  "subscription": {
    "id": "text",
    "name": "text"
  },
  "line": {
    "id": "text",
    "audit": {
      "created": {},
      "updated": {},
      "terminated": {},
      "deleted": {}
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "quantity": 1,
    "item": {
      "id": "text",
      "audit": {},
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "description": "text",
      "externalIds": {
        "vendor": "text",
        "operations": "text"
      },
      "group": {
        "id": "text",
        "name": "text"
      },
      "unit": {
        "id": "text",
        "description": "text",
        "name": "text"
      },
      "terms": {
        "model": "one-time",
        "period": "1m",
        "commitment": "1m"
      },
      "quantityNotApplicable": true,
      "status": "text",
      "product": {
        "id": "text",
        "name": "text",
        "externalIds": {
          "operations": "text",
          "defaultErpItem": "text"
        },
        "icon": "text",
        "status": "text"
      },
      "parameters": [
        {
          "id": "text",
          "externalId": "text",
          "type": "text",
          "name": "text",
          "value": null,
          "displayValue": "text"
        }
      ]
    },
    "price": {
      "currency": "text",
      "markup": 1,
      "margin": 1,
      "defaultMarkupSource": {
        "type": "text",
        "ref": {
          "id": "text",
          "name": "text"
        }
      },
      "markupSource": {
        "type": "text",
        "ref": {
          "id": "text",
          "name": "text"
        }
      },
      "unitSP": 1,
      "unitPP": 1,
      "PPx1": 1,
      "SPx1": 1,
      "SPxY": 1,
      "SPxM": 1,
      "PPxY": 1,
      "PPxM": 1
    },
    "order": {
      "id": "text",
      "audit": {},
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "type": "text",
      "status": "text",
      "notes": "text",
      "comments": "text",
      "statusNotes": {
        "id": "text",
        "message": "text",
        "parameters": null
      },
      "template": {
        "id": "text",
        "name": "text"
      },
      "listing": {
        "id": "text"
      },
      "authorization": {
        "id": "text",
        "name": "text",
        "currency": "text"
      },
      "agreement": {
        "id": "text",
        "icon": "text",
        "status": "text",
        "name": "text"
      },
      "assignee": {
        "id": "text",
        "name": "text",
        "icon": "text"
      },
      "externalIds": {
        "client": "text",
        "operations": "text",
        "vendor": "text"
      },
      "price": {
        "currency": "text",
        "markup": 1,
        "margin": 1,
        "defaultMarkupSource": {
          "type": "text",
          "ref": {
            "id": "text",
            "name": "text"
          }
        },
        "markupSource": {
          "type": "text",
          "ref": {
            "id": "text",
            "name": "text"
          }
        },
        "defaultMarkup": 1,
        "PPx1": 1,
        "SPx1": 1,
        "SPxY": 1,
        "SPxM": 1,
        "PPxY": 1,
        "PPxM": 1
      },
      "lines": [
        "[Circular Reference]"
      ],
      "subscriptions": [
        "[Circular Reference]"
      ],
      "assets": [
        "[Circular Reference]"
      ],
      "parameters": {
        "ordering": [
          {
            "id": "text",
            "externalId": "text",
            "name": "text",
            "type": "text",
            "phase": "text",
            "error": {
              "id": "text",
              "message": "text",
              "parameters": null
            },
            "constraints": {
              "required": true,
              "hidden": true,
              "readonly": true
            },
            "displayValue": "text",
            "value": null
          }
        ],
        "fulfillment": [
          {
            "id": "text",
            "externalId": "text",
            "name": "text",
            "type": "text",
            "phase": "text",
            "error": {
              "id": "text",
              "message": "text",
              "parameters": null
            },
            "constraints": {
              "required": true,
              "hidden": true,
              "readonly": true
            },
            "displayValue": "text",
            "value": null
          }
        ]
      },
      "error": {
        "id": "text",
        "message": "text",
        "parameters": null
      },
      "product": {
        "id": "text",
        "name": "text",
        "externalIds": {
          "operations": "text",
          "defaultErpItem": "text"
        },
        "icon": "text",
        "status": "text"
      },
      "client": {
        "id": "text",
        "icon": "text",
        "type": "text",
        "status": "text",
        "name": "text"
      },
      "licensee": {
        "id": "text",
        "icon": "text",
        "name": "text",
        "externalId": "text"
      },
      "buyer": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "seller": {
        "id": "text",
        "icon": "text",
        "externalId": "text",
        "name": "text"
      },
      "vendor": {
        "id": "text",
        "icon": "text",
        "type": "text",
        "status": "text",
        "name": "text"
      },
      "billTo": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "pricingPolicy": {},
      "termsAndConditions": [
        "[Circular Reference]"
      ],
      "certificates": [
        {
          "id": "text",
          "name": "text"
        }
      ],
      "defaultMarkupSource": "text"
    },
    "status": "text",
    "subscription": {
      "id": "text",
      "audit": {},
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "startDate": "2026-02-19T16:01:59.280Z",
      "terminationDate": "2026-02-19T16:01:59.280Z",
      "externalIds": {
        "client": "text",
        "operations": "text",
        "vendor": "text"
      },
      "terms": {
        "model": "one-time",
        "period": "1m",
        "commitment": "1m"
      },
      "product": {
        "id": "text",
        "name": "text",
        "externalIds": {
          "operations": "text",
          "defaultErpItem": "text"
        },
        "icon": "text",
        "status": "text"
      },
      "autoRenew": true,
      "status": "text",
      "commitmentDate": "2026-02-19T16:01:59.280Z",
      "price": {
        "currency": "text",
        "markup": 1,
        "margin": 1,
        "defaultMarkupSource": {
          "type": "text",
          "ref": {
            "id": "text",
            "name": "text"
          }
        },
        "markupSource": {
          "type": "text",
          "ref": {
            "id": "text",
            "name": "text"
          }
        },
        "SPxY": 1,
        "SPxM": 1,
        "PPxY": 1,
        "PPxM": 1,
        "defaultMarkup": 1,
        "defaultMargin": 1
      },
      "parameters": {
        "fulfillment": [
          {
            "id": "text",
            "externalId": "text",
            "name": "text",
            "type": "text",
            "phase": "text",
            "error": {
              "id": "text",
              "message": "text",
              "parameters": null
            },
            "constraints": {
              "required": true,
              "hidden": true,
              "readonly": true
            },
            "displayValue": "text",
            "value": null
          }
        ]
      },
      "agreement": {
        "id": "text",
        "icon": "text",
        "status": "text",
        "name": "text"
      },
      "buyer": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "licensee": {
        "id": "text",
        "icon": "text",
        "name": "text",
        "externalId": "text"
      },
      "seller": {
        "id": "text",
        "icon": "text",
        "externalId": "text",
        "name": "text"
      },
      "split": {
        "id": "text"
      },
      "splitStatus": "text",
      "lines": [
        "[Circular Reference]"
      ],
      "template": {
        "id": "text",
        "name": "text"
      }
    },
    "asset": {
      "id": "text",
      "audit": {},
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "externalIds": {
        "client": "text",
        "operations": "text",
        "vendor": "text"
      },
      "status": "text",
      "price": {
        "currency": "text",
        "markup": 1,
        "margin": 1,
        "defaultMarkupSource": {
          "type": "text",
          "ref": {
            "id": "text",
            "name": "text"
          }
        },
        "markupSource": {
          "type": "text",
          "ref": {
            "id": "text",
            "name": "text"
          }
        },
        "PPx1": 1,
        "SPx1": 1,
        "defaultMarkup": 1,
        "defaultMargin": 1
      },
      "template": {
        "id": "text",
        "name": "text"
      },
      "parameters": {
        "fulfillment": [
          {
            "id": "text",
            "externalId": "text",
            "name": "text",
            "type": "text",
            "phase": "text",
            "error": {
              "id": "text",
              "message": "text",
              "parameters": null
            },
            "constraints": {
              "required": true,
              "hidden": true,
              "readonly": true
            },
            "displayValue": "text",
            "value": null
          }
        ]
      },
      "terms": {
        "model": "one-time",
        "period": "1m",
        "commitment": "1m"
      },
      "agreement": {
        "id": "text",
        "icon": "text",
        "status": "text",
        "name": "text"
      },
      "product": {
        "id": "text",
        "name": "text",
        "externalIds": {
          "operations": "text",
          "defaultErpItem": "text"
        },
        "icon": "text",
        "status": "text"
      },
      "priceList": {
        "id": "text",
        "currency": "text"
      },
      "listing": {
        "id": "text"
      },
      "licensee": {
        "id": "text",
        "icon": "text",
        "name": "text",
        "externalId": "text"
      },
      "lines": [
        "[Circular Reference]"
      ]
    },
    "agreement": {
      "id": "text",
      "audit": {},
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "icon": "text",
      "status": "text",
      "listing": {
        "id": "text"
      },
      "authorization": {
        "id": "text",
        "name": "text",
        "currency": "text"
      },
      "vendor": {
        "id": "text",
        "icon": "text",
        "type": "text",
        "status": "text",
        "name": "text"
      },
      "client": {
        "id": "text",
        "icon": "text",
        "type": "text",
        "status": "text",
        "name": "text"
      },
      "price": {
        "currency": "text",
        "markup": 1,
        "margin": 1,
        "defaultMarkupSource": {
          "type": "text",
          "ref": {
            "id": "text",
            "name": "text"
          }
        },
        "markupSource": {
          "type": "text",
          "ref": {
            "id": "text",
            "name": "text"
          }
        },
        "SPxY": 1,
        "SPxM": 1,
        "PPxY": 1,
        "PPxM": 1,
        "defaultMarkup": 1,
        "defaultMargin": 1
      },
      "startDate": "2026-02-19T16:01:59.280Z",
      "endDate": "2026-02-19T16:01:59.280Z",
      "template": {
        "id": "text",
        "name": "text"
      },
      "error": {
        "id": "text",
        "message": "text",
        "parameters": null
      },
      "name": "text",
      "lines": [
        "[Circular Reference]"
      ],
      "assets": [
        {
          "id": "text",
          "name": "text",
          "status": "text"
        }
      ],
      "subscriptions": [
        {
          "id": "text",
          "name": "text"
        }
      ],
      "parameters": {
        "ordering": [
          {
            "id": "text",
            "externalId": "text",
            "name": "text",
            "type": "text",
            "phase": "text",
            "error": {
              "id": "text",
              "message": "text",
              "parameters": null
            },
            "constraints": {
              "required": true,
              "hidden": true,
              "readonly": true
            },
            "displayValue": "text",
            "value": null
          }
        ],
        "fulfillment": [
          {
            "id": "text",
            "externalId": "text",
            "name": "text",
            "type": "text",
            "phase": "text",
            "error": {
              "id": "text",
              "message": "text",
              "parameters": null
            },
            "constraints": {
              "required": true,
              "hidden": true,
              "readonly": true
            },
            "displayValue": "text",
            "value": null
          }
        ]
      },
      "licensee": {
        "id": "text",
        "icon": "text",
        "name": "text",
        "externalId": "text"
      },
      "buyer": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "seller": {
        "id": "text",
        "icon": "text",
        "externalId": "text",
        "name": "text"
      },
      "product": {
        "id": "text",
        "name": "text",
        "externalIds": {
          "operations": "text",
          "defaultErpItem": "text"
        },
        "icon": "text",
        "status": "text"
      },
      "externalIds": {
        "client": "text",
        "operations": "text",
        "vendor": "text"
      },
      "split": {},
      "termsAndConditions": [
        "[Circular Reference]"
      ],
      "certificates": [
        {
          "id": "text",
          "name": "text"
        }
      ]
    },
    "client": {
      "id": "text",
      "audit": {},
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "icon": "text",
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "type": "text",
      "status": "text",
      "serviceLevel": "text",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "[email protected]",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "logo": "text",
          "isDefault": true
        }
      ],
      "eligibility": {
        "client": true,
        "partner": true
      }
    },
    "vendor": {
      "id": "text",
      "audit": {},
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "icon": "text",
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "type": "text",
      "status": "text",
      "serviceLevel": "text",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "[email protected]",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "logo": "text",
          "isDefault": true
        }
      ],
      "eligibility": {
        "client": true,
        "partner": true
      }
    },
    "buyer": {
      "id": "text",
      "audit": {},
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "icon": "text",
      "contact": {},
      "externalIds": {
        "erpCompanyContact": "text",
        "erpCustomer": "text",
        "accountExternalId": "text"
      },
      "status": "text",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "taxId": "text",
      "account": {
        "id": "text",
        "icon": "text",
        "type": "text",
        "status": "text",
        "name": "text"
      },
      "name": "text",
      "errors": [
        {
          "id": "text",
          "message": "text",
          "parameters": null
        }
      ],
      "sellers": [
        {
          "id": "text",
          "icon": "text",
          "externalId": "text",
          "name": "text"
        }
      ]
    },
    "seller": {
      "id": "text",
      "audit": {},
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "icon": "text",
      "externalId": "text",
      "status": "text",
      "currencies": [
        "text"
      ],
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "name": "text",
      "erpLink": {
        "id": "text",
        "icon": "text",
        "name": "text",
        "companyName": "text",
        "status": "text"
      }
    },
    "product": {
      "id": "text",
      "audit": {},
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "shortDescription": "text",
      "longDescription": "text",
      "externalIds": {
        "operations": "text",
        "defaultErpItem": "text"
      },
      "website": "text",
      "icon": "text",
      "status": "text",
      "vendor": {
        "id": "text",
        "icon": "text",
        "type": "text",
        "status": "text",
        "name": "text"
      },
      "settings": {
        "productOrdering": true,
        "productRequests": {
          "enabled": true,
          "name": "text",
          "label": "text"
        },
        "itemSelection": true,
        "orderQueueChanges": true,
        "preValidation": {
          "purchaseOrderDraft": true,
          "purchaseOrderQuerying": true,
          "changeOrderDraft": true,
          "configurationOrderDraft": true,
          "terminationOrder": true,
          "productRequest": true
        },
        "splitBilling": {
          "enabled": true,
          "type": "text"
        },
        "subscriptionCessation": {
          "enabled": true,
          "mode": "Termination"
        }
      },
      "statistics": {
        "itemCount": 1,
        "ordersPlacedCount": 1,
        "agreementCount": 1,
        "subscriptionCount": 1,
        "requestCount": 1
      }
    }
  },
  "order": {
    "id": "text"
  },
  "asset": {
    "id": "text",
    "name": "text",
    "status": "text"
  },
  "item": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "vendor": "text",
      "operations": "text"
    }
  },
  "authorization": {
    "id": "text",
    "name": "text",
    "currency": "text"
  },
  "statement": {
    "id": "SOM-1234-1234-1234-1234-1234"
  },
  "statementType": "Debit",
  "processing": {
    "status": "Ready",
    "errors": [
      "Invalid charge amount",
      "Missing buyer information"
    ]
  },
  "erpData": {
    "erpCountryCode": "US",
    "defaultErpProductId": "PROD-12345",
    "defaultErpProductName": "Standard Product",
    "cdg": "CDG-001",
    "scu": "SCU-123",
    "cco": "CCO-456",
    "erpItemId": "ITEM-789"
  },
  "buyer": {
    "id": "text",
    "icon": "text",
    "name": "text"
  },
  "vendor": {
    "id": "text",
    "icon": "text",
    "type": "text",
    "status": "text",
    "name": "text"
  },
  "seller": {
    "id": "text",
    "icon": "text",
    "externalId": "text",
    "name": "text"
  },
  "split": {
    "percentage": 50
  },
  "reconciliation": {
    "type": "Match",
    "source": "Unknown",
    "reason": "text",
    "original": {
      "subscription": {
        "id": "text",
        "name": "text"
      },
      "agreement": {
        "id": "text",
        "icon": "text",
        "status": "text",
        "name": "text"
      },
      "line": "[Circular Reference]",
      "order": {
        "id": "text"
      }
    }
  }
}