WAwafeq
Credit Notes

List credit notes

Changed on

Endpoint for retrieving a list of credit notes.

get/credit-notes/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/credit-notes/
  • Auth
    API key in header Authorization

Query parameters

branchstring

The unique identifier of the branch.

contactstring

The unique identifier of the contact.

created_ts_afterstring date-time

The timestamp in UTC when the credit note was created

created_ts_beforestring date-time

The timestamp in UTC when the credit note was created

credit_note_datestring date

Credit note date

expandstring

Comma-separated related objects to return in full instead of as IDs. Accepted values: attachments, branch, contact, contact.persons, journal, line_items, line_items.account, line_items.cost_center, line_items.item, line_items.tax_rate, project, warehouse. 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}.

external_idstring

External identifier

modified_ts_afterstring date-time

The timestamp in UTC when the credit note was last modified

modified_ts_beforestring date-time

The timestamp in UTC when the credit note was last modified

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

projectstring

The unique identifier of the project.

statusstring

The status of the credit note

Response

countinteger required

The total number of results across all pages.

nextstring uri nullable

The URL of the next page of results, or null on the last page.

previousstring uri nullable

The URL of the previous page of results, or null on the first page.

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes

  • b8f5e10134b4Revision changes
    • breaking

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

    • warning

      removed the optional property // from the response with the status

    • info

      added the new optional query request parameter expand

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

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

    • info

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

    • info

      removed from the // response property allOf list for the response status

    • info

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

    • info

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

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status