WAwafeq
Manual Journals

Retrieve manual journal

Changed on

Endpoint for retrieving a single manual journal.

get/manual-journals/{id}/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/manual-journals/{id}/
  • Auth
    API key in header Authorization

Path parameters

idstring required

Query parameters

expandstring

Comma-separated related objects to return in full instead of as IDs. Accepted values: attachments, journal, line_items, line_items.account, line_items.branch, line_items.contact, line_items.cost_center, line_items.project, line_items.tax_rate. Nested relations are joined with a dot. Pass journal to replace the journal ID with its object (ID, date, currency, reference, notes and timestamps). Documents without a journal still return null. Journal line items are retrieved separately with GET /v1/journal-line-items/?journal={journal_id}.

Response

attachmentsstring[]

The attachments linked to this manual journal.

created_tsstring date-time required

The timestamp in UTC when the journal was created

datestring date required

The date of the manual journal.

external_idstring

External identifier for the manual journal.

idstring required

The id of the object.

legacy_idstring required

[Deprecated] The legacy identifier of the manual journal.

modified_tsstring date-time required

The timestamp in UTC when the journal was last modified

notesstring

The notes of the manual journal.

referencestring

The reference of the manual journal

serial_numberstring required

The serial number assigned to the manual journal.

tax_amount_type'TAX_INCLUSIVE' | 'TAX_EXCLUSIVE'

Whether amounts include or exclude tax.

View the enum reference

Changes

  • b8f5e10134b4Revision changes
    • breaking

      the // response's property type changed from string to no type for status

    • info

      added the new optional query request parameter expand

    • info

      added to the // response property allOf list for the response status

    • info

      the response's property default value was added for the status

    • info

      removed the ABU_DHABI enum value from the // response property for the response status

    • info

      removed the AJMAN enum value from the // response property for the response status

    • info

      removed the DUBAI enum value from the // response property for the response status

    • info

      removed the FUJAIRAH enum value from the // response property for the response status

    • info

      removed the OUTSIDE_UAE enum value from the // response property for the response status

    • info

      removed the RAS_AL_KHAIMAH enum value from the // response property for the response status

    • info

      removed the SHARJAH enum value from the // response property for the response status

    • info

      removed the UMM_AL_QUWAIN enum value from the // response property for the response status

    • info

      added the required property to the response with the status