Inquire Journal

Enquiry the journal.

post

Path parameters

idstringRequired

The ID of the journal.

Body

application/jsontext/jsonapplication/*+json

Represents a journal entry in the billing system.

$metaall of | nullableOptional

Platform entity metadata.

namestringOptional

Represents the name associated with the entity.

Example: Sample Entity

iconstring | nullableOptional

Represents the icon linked to the entity, if applicable.

Example: icon.png

auditall ofOptional

Contains audit-related details for the entity.

idstringOptional

The unique identifier of the journal entry.

Example: BJO-1234-1234

descriptionstringOptional

A description of the journal entry.

Example: Monthly revenue journal entry

externalIdsall ofOptional

External identifiers associated with the journal entry.

notesstring | nullableOptional

Additional notes or comments about the journal entry.

Example: Includes adjustments for Q1 2025

statusall ofOptional

The current status of the journal entry.

Example: Validated

string · enumOptional

Represents the various statuses a journal can have in the billing system.

Possible values:

vendorall ofOptional

ownerall ofOptional

productall ofOptional

authorizationall ofOptional

dueDatestring · date-timeOptional

The due date for the journal entry.

Example: 2025-05-15T23:59:59.0000000+00:00

assigneeall ofOptional

priceall ofOptional

Pricing details associated with the journal entry.

uploadall ofOptional

Upload summary details for the journal entry, visible to vendors or operations.

processingall ofOptional

Processing status and related details for the journal entry, visible to operations.

errorall of | nullableOptional

Error details associated with the journal entry, if any.

Responses

200

OK

application/json

403

Forbidden

application/json

404

Not Found

application/json

post

HTTPcURLJavaScriptPython

POST /public/v1/billing/journals/{id}/enquiry HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 2120

{
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "Sample Entity",
  "icon": "icon.png",
  "audit": {
    "created": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "id": "BJO-1234-1234",
  "description": "Monthly revenue journal entry",
  "externalIds": {
    "operations": "OPS-12345",
    "vendor": "VND-67890"
  },
  "notes": "Includes adjustments for Q1 2025",
  "status": "Validated",
  "vendor": {
    "id": "text",
    "icon": "text",
    "type": "Client",
    "status": "Active",
    "name": "text"
  },
  "owner": {
    "id": "text",
    "icon": "text",
    "externalId": "text",
    "name": "text",
    "erpLink": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-05-17T09:11:32.397Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "updated": {
          "at": "2025-05-17T09:11:32.397Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "blocked": {
          "at": "2025-05-17T09:11:32.397Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "unblocked": {
          "at": "2025-05-17T09:11:32.397Z",
          "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"
      }
    }
  },
  "product": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "operations": "text"
    },
    "icon": "text",
    "status": "text"
  },
  "authorization": {
    "id": "text",
    "name": "text",
    "currency": "text"
  },
  "dueDate": "2025-05-15T23:59:59.0000000+00:00",
  "assignee": {
    "id": "text",
    "name": "text",
    "icon": "text"
  },
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalSP": 1200,
    "currency": "EUR"
  },
  "upload": {
    "total": 100,
    "split": 10,
    "ready": 85,
    "error": 5
  },
  "processing": {
    "total": 100,
    "ready": 80,
    "error": 5,
    "split": 10,
    "skipped": 5
  },
  "error": {
    "errorCode": "ERR-001",
    "errorMessage": "Invalid billing data provided.",
    "id": "12345",
    "message": "Failed to process the billing entity due to missing data."
  }
}

application/jsontext/jsonapplication/*+json

{
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "Sample Entity",
  "icon": "icon.png",
  "audit": {
    "created": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "id": "BJO-1234-1234",
  "description": "Monthly revenue journal entry",
  "externalIds": {
    "operations": "OPS-12345",
    "vendor": "VND-67890"
  },
  "notes": "Includes adjustments for Q1 2025",
  "status": "Validated",
  "vendor": {
    "id": "text",
    "icon": "text",
    "type": "Client",
    "status": "Active",
    "name": "text"
  },
  "owner": {
    "id": "text",
    "icon": "text",
    "externalId": "text",
    "name": "text",
    "erpLink": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-05-17T09:11:32.397Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "updated": {
          "at": "2025-05-17T09:11:32.397Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "blocked": {
          "at": "2025-05-17T09:11:32.397Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "unblocked": {
          "at": "2025-05-17T09:11:32.397Z",
          "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"
      }
    }
  },
  "product": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "operations": "text"
    },
    "icon": "text",
    "status": "text"
  },
  "authorization": {
    "id": "text",
    "name": "text",
    "currency": "text"
  },
  "dueDate": "2025-05-15T23:59:59.0000000+00:00",
  "assignee": {
    "id": "text",
    "name": "text",
    "icon": "text"
  },
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalSP": 1200,
    "currency": "EUR"
  },
  "upload": {
    "total": 100,
    "split": 10,
    "ready": 85,
    "error": 5
  },
  "processing": {
    "total": 100,
    "ready": 80,
    "error": 5,
    "split": 10,
    "skipped": 5
  },
  "error": {
    "errorCode": "ERR-001",
    "errorMessage": "Invalid billing data provided.",
    "id": "12345",
    "message": "Failed to process the billing entity due to missing data."
  }
}