List credit notes

get

https://api.wafeq.com/v1/credit-notes/

Endpoint for retrieving a list of credit notes.

Query Params

branch

string

The unique identifier of the branch.

contact

string

The unique identifier of the contact.

created_ts_after

date-time

The timestamp in UTC when the credit note was created

created_ts_before

date-time

The timestamp in UTC when the credit note was created

credit_note_date

date

Credit note date

expand

string

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_id

string

External identifier

modified_ts_after

date-time

The timestamp in UTC when the credit note was last modified

modified_ts_before

date-time

The timestamp in UTC when the credit note was last modified

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

project

string

The unique identifier of the project.

status

string

The status of the credit note

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200