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

404

Not Found

application/json

get

HTTPcURLJavaScriptPython

GET /public/v1/billing/journals/{journalId}/charges/{id} HTTP/1.1
Host: 
Accept: */*

{
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "id": "CHG-1234-1234-1234-1234-1234",
  "externalIds": {
    "reference": "REF-67890",
    "invoice": "INV-12345",
    "vendor": "VND-54321"
  },
  "search": {
    "subscription": {
      "criteria": "externalIds.Vendor",
      "value": "EXT-12345"
    },
    "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"
    },
    "markup": 15.5,
    "margin": 20,
    "unitPP": 100,
    "PPx1": 1000,
    "unitSP": 120,
    "SPx1": 1200
  },
  "segment": "Segment-A",
  "description": {
    "value1": "Monthly subscription charge",
    "value2": "Includes additional services"
  },
  "journal": {
    "name": "Sample Entity",
    "icon": "icon.png",
    "id": "BJO-1234-1234",
    "dueDate": "2025-05-15T23:59:59.0000000+00:00"
  },
  "ledger": {
    "name": "Sample Entity",
    "icon": "icon.png",
    "id": "BLE-1234-1234-1234-1234"
  },
  "customLedger": {
    "icon": "icon.png",
    "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": "New",
    "name": "text"
  },
  "subscription": {
    "id": "text",
    "name": "text"
  },
  "order": {
    "id": "text"
  },
  "item": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "vendor": "text",
      "operations": "text"
    }
  },
  "authorization": {
    "id": "text",
    "name": "text",
    "currency": "text"
  },
  "statement": {
    "name": "Sample Entity",
    "icon": "icon.png",
    "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": "Client",
    "status": "Active",
    "name": "text"
  },
  "seller": {
    "id": "text",
    "icon": "text",
    "externalId": "text",
    "name": "text",
    "erpLink": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-05-12T13:58:35.882Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "updated": {
          "at": "2025-05-12T13:58:35.882Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "blocked": {
          "at": "2025-05-12T13:58:35.882Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "unblocked": {
          "at": "2025-05-12T13:58:35.882Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "icon": "text",
      "buyer": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "seller": {
        "id": "text",
        "icon": "text",
        "externalId": "text",
        "name": "text",
        "erpLink": "[Circular Reference]"
      },
      "name": "text",
      "status": "Active",
      "note": "text",
      "externalIds": {
        "erpCompanyContact": "text",
        "erpCustomer": "text",
        "accountExternalId": "text"
      },
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      }
    }
  },
  "attributes": {
    "documentNumber": "DOC-12345",
    "orderType": "PurchaseOrder",
    "externalDocumentNo": "EXT-67890",
    "externalDocumentNo2": "EXT2-54321",
    "yourReference": "CUST-REF-001"
  },
  "split": {
    "percentage": 50
  }
}