🟢 READ-ONLY · Accounts · GET /accounts/

List accounts

Endpoint for retrieving a list of accounts.

🟡 WRITE · creates data · Accounts · POST /accounts/

Create account

Endpoint for creating a new account.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Accounts · GET /accounts/{id}/

Retrieve account

Endpoint for retrieving a single account.

🟡 WRITE · updates data · Accounts · PUT /accounts/{id}/

Update account

Endpoint for updating an existing account.

🔴 DESTRUCTIVE · deletes · Accounts · DELETE /accounts/{id}/

Delete account

Endpoint for deleting an existing account.

Permanently removes the record.

🟡 WRITE · updates data · Accounts · PATCH /accounts/{id}/

Partial update account

Endpoint for partially updating an existing account.

🟢 READ-ONLY · Amortizations · GET /amortizations/

List amortizations

Endpoint for retrieving a list of amortizations.

🟢 READ-ONLY · preview / simulation · Amortizations · POST /amortizations/preview/

Preview amortization schedule

Endpoint for previewing the amortization events that would be generated for the given schedule, without creating an amortization.

This is a POST, but Wafeq documents it as a simulation: it returns the events that WOULD be generated and writes nothing to the ledger.

🟢 READ-ONLY · Amortizations · GET /amortizations/{id}/

Retrieve amortization

Endpoint for retrieving a single amortization.

🔴 DESTRUCTIVE · deletes · Amortizations · DELETE /amortizations/{id}/

Delete amortization

Endpoint for deleting an existing amortization.

Permanently removes the record.

🔴 IRREVERSIBLE · posts the remaining balance to the ledger · Amortizations · POST /amortizations/{id}/end-early/

End amortization early

Endpoint for terminating an amortization early, recognizing the remaining balance against the provided account.

Terminates a schedule early and recognizes its whole remaining balance immediately. There is no API undo. Run the matching preview_... tool first to see exactly what would be posted.

🟢 READ-ONLY · preview / simulation · Amortizations · POST /amortizations/{id}/preview-end-early/

Preview early termination

Endpoint for previewing the remaining balance and the posted events that would be reversed by terminating the amortization early at the given date.

This is a POST, but Wafeq documents it as a simulation: it returns the events that WOULD be generated and writes nothing to the ledger.

🟢 READ-ONLY · Bank Accounts · GET /bank-accounts/

List bank accounts

Endpoint for retrieving a list of bank accounts.

🟡 WRITE · creates data · Bank Accounts · POST /bank-accounts/

Create bank account

Endpoint for creating a new bank account.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Bank Ledger Transactions · GET /bank-accounts/{bank_account_id}/ledger-transactions/

List bank ledger transactions

Endpoint for retrieving a list of bank ledger transactions.

🟡 WRITE · creates data · Bank Ledger Transactions · POST /bank-accounts/{bank_account_id}/ledger-transactions/

Create bank ledger transaction

Endpoint for creating a new bank ledger transaction.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Bank Ledger Transactions · GET /bank-accounts/{bank_account_id}/ledger-transactions/{id}/

Retrieve bank ledger transaction

Endpoint for retrieving a single bank ledger transaction.

🟡 WRITE · updates data · Bank Ledger Transactions · PUT /bank-accounts/{bank_account_id}/ledger-transactions/{id}/

Update bank ledger transaction

Endpoint for updating an existing bank ledger transaction.

🔴 DESTRUCTIVE · deletes · Bank Ledger Transactions · DELETE /bank-accounts/{bank_account_id}/ledger-transactions/{id}/

Delete bank ledger transaction

Endpoint for deleting an existing bank ledger transaction.

Permanently removes the record.

🟡 WRITE · updates data · Bank Ledger Transactions · PATCH /bank-accounts/{bank_account_id}/ledger-transactions/{id}/

Partial update bank ledger transaction

Endpoint for partially updating an existing bank ledger transaction.

🟢 READ-ONLY · Bank Statement Transactions · GET /bank-accounts/{bank_account_id}/statement-transactions/

List bank statement transactions

Endpoint for retrieving a list of bank statement transactions.

🟡 WRITE · creates data · Bank Statement Transactions · POST /bank-accounts/{bank_account_id}/statement-transactions/

Create bank statement transaction

Endpoint for creating a new bank statement transaction.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Bank Statement Transactions · GET /bank-accounts/{bank_account_id}/statement-transactions/{id}/

Retrieve bank statement transaction

Endpoint for retrieving a single bank statement transaction.

🟡 WRITE · updates data · Bank Statement Transactions · PUT /bank-accounts/{bank_account_id}/statement-transactions/{id}/

Update bank statement transaction

Endpoint for updating an existing bank statement transaction.

🔴 DESTRUCTIVE · deletes · Bank Statement Transactions · DELETE /bank-accounts/{bank_account_id}/statement-transactions/{id}/

Delete bank statement transaction

Endpoint for deleting an existing bank statement transaction.

Permanently removes the record.

🟡 WRITE · updates data · Bank Statement Transactions · PATCH /bank-accounts/{bank_account_id}/statement-transactions/{id}/

Partial update bank statement transaction

Endpoint for partially updating an existing bank statement transaction.

🟢 READ-ONLY · Bank Accounts · GET /bank-accounts/{id}/

Retrieve bank account

Endpoint for retrieving a single bank account.

🟡 WRITE · updates data · Bank Accounts · PUT /bank-accounts/{id}/

Update bank account

Endpoint for updating an existing bank account.

🔴 DESTRUCTIVE · deletes · Bank Accounts · DELETE /bank-accounts/{id}/

Delete bank account

Endpoint for deleting an existing bank account.

Permanently removes the record.

🟡 WRITE · updates data · Bank Accounts · PATCH /bank-accounts/{id}/

Partial update bank account

Endpoint for partially updating an existing bank account.

🟢 READ-ONLY · Beneficiaries · GET /beneficiaries/

List beneficiaries

Endpoint for retrieving a list of beneficiaries.

🟡 WRITE · creates data · Beneficiaries · POST /beneficiaries/

Create beneficiary

Endpoint for creating a new beneficiary.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Beneficiaries · GET /beneficiaries/{id}/

Retrieve beneficiary

Endpoint for retrieving a single beneficiary.

🟡 WRITE · updates data · Beneficiaries · PUT /beneficiaries/{id}/

Update beneficiary

Endpoint for updating an existing beneficiary.

🔴 DESTRUCTIVE · deletes · Beneficiaries · DELETE /beneficiaries/{id}/

Delete beneficiary

Endpoint for deleting an existing beneficiary.

Permanently removes the record.

🟡 WRITE · updates data · Beneficiaries · PATCH /beneficiaries/{id}/

Partial update beneficiary

Endpoint for partially updating an existing beneficiary.

🟢 READ-ONLY · Bills · GET /bills/

List bills

Endpoint for retrieving a list of bills.

🟡 WRITE · creates data · Bills · POST /bills/

Create bill

Endpoint for creating a new bill.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Bill Line Items · GET /bills/{bill_id}/line-items/

List bill line items

Endpoint for retrieving a list of bill line items.

🟡 WRITE · creates data · Bill Line Items · POST /bills/{bill_id}/line-items/

Create bill line item

Endpoint for creating a new bill line item.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Bill Line Items · GET /bills/{bill_id}/line-items/{id}/

Retrieve bill line item

Endpoint for retrieving a single bill line item.

🟡 WRITE · updates data · Bill Line Items · PUT /bills/{bill_id}/line-items/{id}/

Update bill line item

Endpoint for updating an existing bill line item.

🔴 DESTRUCTIVE · deletes · Bill Line Items · DELETE /bills/{bill_id}/line-items/{id}/

Delete bill line item

Endpoint for deleting an existing bill line item.

Permanently removes the record.

🟡 WRITE · updates data · Bill Line Items · PATCH /bills/{bill_id}/line-items/{id}/

Partial update bill line item

Endpoint for partially updating an existing bill line item.

🟢 READ-ONLY · Bills · GET /bills/{id}/

Retrieve bill

Endpoint for retrieving a single bill.

🟡 WRITE · updates data · Bills · PUT /bills/{id}/

Update bill

Endpoint for updating an existing bill.

🔴 DESTRUCTIVE · deletes · Bills · DELETE /bills/{id}/

Delete bill

Endpoint for deleting an existing bill.

Permanently removes the record.

🟡 WRITE · updates data · Bills · PATCH /bills/{id}/

Partial update bill

Endpoint for partially updating an existing bill.

🟢 READ-ONLY · returns a PDF · Bills · GET /bills/{id}/download/

Download bill PDF

Endpoint for downloading a PDF of the bill.

Returns the document as base64-encoded PDF bytes plus its size and content type. Nothing is modified.

🟢 READ-ONLY · Branches · GET /branches/

List branches

Endpoint for retrieving a list of branches.

🟡 WRITE · creates data · Branches · POST /branches/

Create branch

Endpoint for creating a new branch.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Branches · GET /branches/{id}/

Retrieve branch

Endpoint for retrieving a single branch.

🟡 WRITE · updates data · Branches · PUT /branches/{id}/

Update branch

Endpoint for updating an existing branch.

🔴 DESTRUCTIVE · deletes · Branches · DELETE /branches/{id}/

Delete branch

Endpoint for deleting an existing branch.

Permanently removes the record.

🟡 WRITE · updates data · Branches · PATCH /branches/{id}/

Partial update branch

Endpoint for partially updating an existing branch.

🟢 READ-ONLY · Contacts · GET /contacts/

List contacts

Endpoint for retrieving a list of contacts.

🟡 WRITE · creates data · Contacts · POST /contacts/

Create contact

Endpoint for creating a new contact.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Contacts · GET /contacts/{id}/

Retrieve contact

Endpoint for retrieving a single contact.

🟡 WRITE · updates data · Contacts · PUT /contacts/{id}/

Update contact

Endpoint for updating an existing contact.

🔴 DESTRUCTIVE · deletes · Contacts · DELETE /contacts/{id}/

Delete contact

Endpoint for deleting an existing contact.

Permanently removes the record.

🟡 WRITE · updates data · Contacts · PATCH /contacts/{id}/

Partial update contact

Endpoint for partially updating an existing contact.

🟢 READ-ONLY · Cost Centers · GET /cost-centers/

List cost centers

Endpoint for retrieving a list of cost centers.

🟡 WRITE · creates data · Cost Centers · POST /cost-centers/

Create cost center

Endpoint for creating a new cost center.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Cost Centers · GET /cost-centers/{id}/

Retrieve cost center

Endpoint for retrieving a single cost center.

🟡 WRITE · updates data · Cost Centers · PUT /cost-centers/{id}/

Update cost center

Endpoint for updating an existing cost center.

🔴 DESTRUCTIVE · deletes · Cost Centers · DELETE /cost-centers/{id}/

Delete cost center

Endpoint for deleting an existing cost center.

Permanently removes the record.

🟡 WRITE · updates data · Cost Centers · PATCH /cost-centers/{id}/

Partial update cost center

Endpoint for partially updating an existing cost center.

🟢 READ-ONLY · Credit Notes · GET /credit-notes/

List credit notes

Endpoint for retrieving a list of credit notes.

🟡 WRITE · creates data · Credit Notes · POST /credit-notes/

Create credit note

Endpoint for creating a new credit note.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Credit Note Line Items · GET /credit-notes/{credit_note_id}/line-items/

List credit note line items

Endpoint for retrieving a list of credit note line items.

🟡 WRITE · creates data · Credit Note Line Items · POST /credit-notes/{credit_note_id}/line-items/

Create credit note line item

Endpoint for creating a new credit note line item.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Credit Note Line Items · GET /credit-notes/{credit_note_id}/line-items/{id}/

Retrieve credit note line item

Endpoint for retrieving a single credit note line item.

🟡 WRITE · updates data · Credit Note Line Items · PUT /credit-notes/{credit_note_id}/line-items/{id}/

Update credit note line item

Endpoint for updating an existing credit note line item.

🔴 DESTRUCTIVE · deletes · Credit Note Line Items · DELETE /credit-notes/{credit_note_id}/line-items/{id}/

Delete credit note line item

Endpoint for deleting an existing credit note line item.

Permanently removes the record.

🟡 WRITE · updates data · Credit Note Line Items · PATCH /credit-notes/{credit_note_id}/line-items/{id}/

Partial update credit note line item

Endpoint for partially updating an existing credit note line item.

🟢 READ-ONLY · Credit Notes · GET /credit-notes/{id}/

Retrieve credit note

Endpoint for retrieving a single credit note.

🟡 WRITE · updates data · Credit Notes · PUT /credit-notes/{id}/

Update credit note

Endpoint for updating an existing credit note.

🔴 DESTRUCTIVE · deletes · Credit Notes · DELETE /credit-notes/{id}/

Delete credit note

Endpoint for deleting an existing credit note.

Permanently removes the record.

🟡 WRITE · updates data · Credit Notes · PATCH /credit-notes/{id}/

Partial update credit note

Endpoint for partially updating an existing credit note.

🟢 READ-ONLY · returns a PDF · Credit Notes · GET /credit-notes/{id}/download/

Download credit note PDF

Endpoint for downloading a PDF of the credit note.

Returns the document as base64-encoded PDF bytes plus its size and content type. Nothing is modified.

🔴 IRREVERSIBLE · files the document with an external tax authority · Credit Notes · POST /credit-notes/{id}/tax-authority/report/

Report credit note to tax authority

Report the credit note to the tax authority for processing and validation.

Submits the document outside your organization for clearance/reporting. It CANNOT be recalled or undone through this API. Confirm with the user before calling, and check the document's contents first.

🟢 READ-ONLY · Custom Fields · GET /custom-fields/

List custom fields

Endpoint for retrieving a list of custom fields.

🟡 WRITE · creates data · Custom Fields · POST /custom-fields/

Create custom field

Endpoint for creating a new custom field.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Custom Fields · GET /custom-fields/{id}/

Retrieve custom field

Endpoint for retrieving a single custom field.

🟡 WRITE · updates data · Custom Fields · PUT /custom-fields/{id}/

Update custom field

Endpoint for updating an existing custom field.

🔴 DESTRUCTIVE · deletes · Custom Fields · DELETE /custom-fields/{id}/

Delete custom field

Endpoint for deleting an existing custom field. The custom field must not be in use on any documents.

Permanently removes the record.

🟡 WRITE · updates data · Custom Fields · PATCH /custom-fields/{id}/

Partial update custom field

Endpoint for partially updating an existing custom field.

🟢 READ-ONLY · Debit Notes · GET /debit-notes/

List debit notes

Endpoint for retrieving a list of debit notes.

🟡 WRITE · creates data · Debit Notes · POST /debit-notes/

Create debit note

Endpoint for creating a new debit note.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Debit Note Line Items · GET /debit-notes/{debit_note_id}/line-items/

List debit note line items

Endpoint for retrieving a list of debit note line items.

🟡 WRITE · creates data · Debit Note Line Items · POST /debit-notes/{debit_note_id}/line-items/

Create debit note line item

Endpoint for creating a new debit note line item.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Debit Note Line Items · GET /debit-notes/{debit_note_id}/line-items/{id}/

Retrieve debit note line item

Endpoint for retrieving a single debit note line item.

🟡 WRITE · updates data · Debit Note Line Items · PUT /debit-notes/{debit_note_id}/line-items/{id}/

Update debit note line item

Endpoint for updating an existing debit note line item.

🔴 DESTRUCTIVE · deletes · Debit Note Line Items · DELETE /debit-notes/{debit_note_id}/line-items/{id}/

Delete debit note line item

Endpoint for deleting an existing debit note line item.

Permanently removes the record.

🟡 WRITE · updates data · Debit Note Line Items · PATCH /debit-notes/{debit_note_id}/line-items/{id}/

Partial update debit note line item

Endpoint for partially updating an existing debit note line item.

🟢 READ-ONLY · Debit Notes · GET /debit-notes/{id}/

Retrieve debit note

Endpoint for retrieving a single debit note.

🟡 WRITE · updates data · Debit Notes · PUT /debit-notes/{id}/

Update debit note

Endpoint for updating an existing debit note.

🔴 DESTRUCTIVE · deletes · Debit Notes · DELETE /debit-notes/{id}/

Delete debit note

Endpoint for deleting an existing debit note.

Permanently removes the record.

🟡 WRITE · updates data · Debit Notes · PATCH /debit-notes/{id}/

Partial update debit note

Endpoint for partially updating an existing debit note.

🟢 READ-ONLY · returns a PDF · Debit Notes · GET /debit-notes/{id}/download/

Download debit note PDF

Endpoint for downloading a PDF of the debit note.

Returns the document as base64-encoded PDF bytes plus its size and content type. Nothing is modified.

🟢 READ-ONLY · Employees · GET /employees/

List employees

Endpoint for retrieving a list of employees.

🟡 WRITE · creates data · Employees · POST /employees/

Create employee

Endpoint for creating a new employee.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Employees · GET /employees/{id}/

Retrieve employee

Endpoint for retrieving a single employee.

🟡 WRITE · updates data · Employees · PUT /employees/{id}/

Update employee

Endpoint for updating an existing employee.

🔴 DESTRUCTIVE · deletes · Employees · DELETE /employees/{id}/

Delete employee

Endpoint for deleting an existing employee.

Permanently removes the record.

🟡 WRITE · updates data · Employees · PATCH /employees/{id}/

Partial update employee

Endpoint for partially updating an existing employee.

🟢 READ-ONLY · Expenses · GET /expenses/

List expenses

Endpoint for retrieving a list of expenses.

🟡 WRITE · creates data · Expenses · POST /expenses/

Create expense

Endpoint for creating a new expense.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Expenses · GET /expenses/{id}/

Retrieve expense

Endpoint for retrieving a single expense.

🟡 WRITE · updates data · Expenses · PUT /expenses/{id}/

Update expense

Endpoint for updating an existing expense.

🔴 DESTRUCTIVE · deletes · Expenses · DELETE /expenses/{id}/

Delete expense

Endpoint for deleting an existing expense.

Permanently removes the record.

🟡 WRITE · updates data · Expenses · PATCH /expenses/{id}/

Partial update expense

Endpoint for partially updating an existing expense.

🟠 STATE CHANGE · moves a document in or out of the ledger · Expenses · POST /expenses/{id}/mark-as-draft/

Mark expense as draft

Moves a posted expense back to draft (removes its journal from the ledger).

Changes posted/draft status, which adds or removes the document's journal from the ledger. Reversible: the opposite tool undoes it.

Removes the expense's journal from the ledger and returns it to draft. Undo with mark expense as posted.

🟠 STATE CHANGE · moves a document in or out of the ledger · Expenses · POST /expenses/{id}/mark-as-posted/

Mark expense as posted

Posts a draft expense to the ledger (generates its journal).

Changes posted/draft status, which adds or removes the document's journal from the ledger. Reversible: the opposite tool undoes it.

Generates the expense's journal and posts it to the ledger. Undo with mark expense as draft.

🟢 READ-ONLY · Files · GET /files/

List files

Endpoint for retrieving a list of files.

🟡 WRITE · creates data · Files · POST /files/

Create file

Endpoint for creating a new file. Upload a file using multipart/form-data.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

Send the file with file_base64 plus filename (and optionally content_type); this server builds the multipart/form-data body for you. For a file already on the machine running this server, pass file_path instead.

🟡 WRITE · creates data · Files · POST /files/raw/

Create file (advance)

Create file in advance mode by sending raw binary file content directly in the request body. You must include a Content-Disposition header with the filename.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

Advanced upload: sends the bytes as the raw request body with a Content-Disposition header. Prefer upload_file unless you specifically need raw mode. Provide file_base64 + filename, or file_path.

🟢 READ-ONLY · Files · GET /files/{id}/

Retrieve file

Endpoint for retrieving a single file.

🔴 DESTRUCTIVE · deletes · Files · DELETE /files/{id}/

Delete file

Endpoint for deleting an existing file.

Permanently removes the record.

🟢 READ-ONLY · Invoices · GET /invoices/

List invoices

Endpoint for retrieving a list of invoices.

🟡 WRITE · creates data · Invoices · POST /invoices/

Create invoice

Endpoint for creating a new invoice.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Invoices · GET /invoices/{id}/

Retrieve invoice

Endpoint for retrieving a single invoice.

🟡 WRITE · updates data · Invoices · PUT /invoices/{id}/

Update invoice

Endpoint for updating an existing invoice.

🔴 DESTRUCTIVE · deletes · Invoices · DELETE /invoices/{id}/

Delete invoice

Endpoint for deleting an existing invoice.

Permanently removes the record.

🟡 WRITE · updates data · Invoices · PATCH /invoices/{id}/

Partial update invoice

Endpoint for partially updating an existing invoice.

🟢 READ-ONLY · returns a PDF · Invoices · GET /invoices/{id}/download/

Download invoice PDF

Endpoint for downloading a PDF of the invoice.

Returns the document as base64-encoded PDF bytes plus its size and content type. Nothing is modified.

🔴 IRREVERSIBLE · files the document with an external tax authority · Invoices · POST /invoices/{id}/tax-authority/report/

Report invoice to tax authority

Report the invoice to the tax authority for processing and validation.

Submits the document outside your organization for clearance/reporting. It CANNOT be recalled or undone through this API. Confirm with the user before calling, and check the document's contents first.

🟢 READ-ONLY · Invoice Line Items · GET /invoices/{invoice_id}/line-items/

List invoice line items

Endpoint for retrieving a list of invoice line items.

🟡 WRITE · creates data · Invoice Line Items · POST /invoices/{invoice_id}/line-items/

Create invoice line item

Endpoint for creating a new invoice line item.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Invoice Line Items · GET /invoices/{invoice_id}/line-items/{id}/

Retrieve invoice line item

Endpoint for retrieving a single invoice line item.

🟡 WRITE · updates data · Invoice Line Items · PUT /invoices/{invoice_id}/line-items/{id}/

Update invoice line item

Endpoint for updating an existing invoice line item.

🔴 DESTRUCTIVE · deletes · Invoice Line Items · DELETE /invoices/{invoice_id}/line-items/{id}/

Delete invoice line item

Endpoint for deleting an existing invoice line item.

Permanently removes the record.

🟡 WRITE · updates data · Invoice Line Items · PATCH /invoices/{invoice_id}/line-items/{id}/

Partial update invoice line item

Endpoint for partially updating an existing invoice line item.

🟢 READ-ONLY · Item Unit Of Measures · GET /item-units-of-measure/

List item unit of measures

Endpoint for retrieving a list of item unit of measures.

🟡 WRITE · creates data · Item Unit Of Measures · POST /item-units-of-measure/

Create item unit of measure

Endpoint for creating a new item unit of measure.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Item Unit Of Measures · GET /item-units-of-measure/{id}/

Retrieve item unit of measure

Endpoint for retrieving a single item unit of measure.

🟡 WRITE · updates data · Item Unit Of Measures · PUT /item-units-of-measure/{id}/

Update item unit of measure

Endpoint for updating an existing item unit of measure.

🔴 DESTRUCTIVE · deletes · Item Unit Of Measures · DELETE /item-units-of-measure/{id}/

Delete item unit of measure

Endpoint for deleting an existing item unit of measure.

Permanently removes the record.

🟡 WRITE · updates data · Item Unit Of Measures · PATCH /item-units-of-measure/{id}/

Partial update item unit of measure

Endpoint for partially updating an existing item unit of measure.

🟢 READ-ONLY · Items · GET /items/

List items

Endpoint for retrieving a list of items.

🟡 WRITE · creates data · Items · POST /items/

Create item

Endpoint for creating a new item.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Items · GET /items/{id}/

Retrieve item

Endpoint for retrieving a single item.

🟡 WRITE · updates data · Items · PUT /items/{id}/

Update item

Endpoint for updating an existing item.

🔴 DESTRUCTIVE · deletes · Items · DELETE /items/{id}/

Delete item

Endpoint for deleting an existing item.

Permanently removes the record.

🟡 WRITE · updates data · Items · PATCH /items/{id}/

Partial update item

Endpoint for partially updating an existing item.

🟢 READ-ONLY · Journal Line Items · GET /journal-line-items/

List journal line items

Endpoint for retrieving a list of journal line items.

NO DATE FIELD: rows carry created_ts (when the row was written to Wafeq) and modified_ts, but NOT the transaction date. created_ts is frequently a different month from the transaction — do not report it as the transaction date. To work by transaction date, filter with date_after/date_before, which DO operate on the real transaction date. For rows that come back already carrying their date, use the wafeq_account_ledger tool instead. Note this endpoint is cursor-paginated (cursor + page_size), unlike the rest of the API, which uses page.

🟢 READ-ONLY · Journal Line Items · GET /journal-line-items/{id}/

Retrieve journal line item

Endpoint for retrieving a single journal line item.

NO DATE FIELD: the row carries created_ts (when it was written to Wafeq), which is not the transaction date. The transaction date lives on the parent journal referenced by the journal field.

🟢 READ-ONLY · Manual Journals · GET /manual-journals/

List manual journals

Endpoint for retrieving a list of manual journals.

🟡 WRITE · creates data · Manual Journals · POST /manual-journals/

Create manual journal

Endpoint for creating a new manual journal.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Manual Journals · GET /manual-journals/{id}/

Retrieve manual journal

Endpoint for retrieving a single manual journal.

🟡 WRITE · updates data · Manual Journals · PUT /manual-journals/{id}/

Update manual journal

Endpoint for updating an existing manual journal.

🔴 DESTRUCTIVE · deletes · Manual Journals · DELETE /manual-journals/{id}/

Delete manual journal

Endpoint for deleting an existing manual journal.

Permanently removes the record.

🟡 WRITE · updates data · Manual Journals · PATCH /manual-journals/{id}/

Partial update manual journal

Endpoint for partially updating an existing manual journal.

🟢 READ-ONLY · Organizations · GET /organization/

Retrieve organization

Endpoint for retrieving a single organization.

🟢 READ-ONLY · Payment Requests · GET /payment_requests/

List payment requests

Endpoint for retrieving a list of payment requests.

🟡 WRITE · creates data · Payment Requests · POST /payment_requests/

Create payment request

Endpoint for creating a new payment request.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Payment Requests · GET /payment_requests/{id}/

Retrieve payment request

Endpoint for retrieving a single payment request.

🟡 WRITE · updates data · Payment Requests · PUT /payment_requests/{id}/

Update payment request

Endpoint for updating an existing payment request.

🔴 DESTRUCTIVE · deletes · Payment Requests · DELETE /payment_requests/{id}/

Delete payment request

Endpoint for deleting an existing payment request.

Permanently removes the record.

🟡 WRITE · updates data · Payment Requests · PATCH /payment_requests/{id}/

Partial update payment request

Endpoint for partially updating an existing payment request.

🟢 READ-ONLY · Payments · GET /payments/

List payments

Endpoint for retrieving a list of payments.

🟡 WRITE · creates data · Payments · POST /payments/

Create payment

Endpoint for creating a new payment.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Payments · GET /payments/{id}/

Retrieve payment

Endpoint for retrieving a single payment.

🟡 WRITE · updates data · Payments · PUT /payments/{id}/

Update payment

Endpoint for updating an existing payment.

🔴 DESTRUCTIVE · deletes · Payments · DELETE /payments/{id}/

Delete payment

Endpoint for deleting an existing payment.

Permanently removes the record.

🟡 WRITE · updates data · Payments · PATCH /payments/{id}/

Partial update payment

Endpoint for partially updating an existing payment.

🟢 READ-ONLY · returns a PDF · Payments · GET /payments/{id}/download/

Download payment PDF

Endpoint for downloading a PDF of the payment.

Returns the document as base64-encoded PDF bytes plus its size and content type. Nothing is modified.

🟢 READ-ONLY · Payslips · GET /payslips/

List payslips

Endpoint for retrieving a list of payslips.

🟡 WRITE · creates data · Payslips · POST /payslips/

Create payslip

Endpoint for creating a new payslip.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Payslips · GET /payslips/{id}/

Retrieve payslip

Endpoint for retrieving a single payslip.

🟡 WRITE · updates data · Payslips · PUT /payslips/{id}/

Update payslip

Endpoint for updating an existing payslip.

🔴 DESTRUCTIVE · deletes · Payslips · DELETE /payslips/{id}/

Delete payslip

Endpoint for deleting an existing payslip.

Permanently removes the record.

🟡 WRITE · updates data · Payslips · PATCH /payslips/{id}/

Partial update payslip

Endpoint for partially updating an existing payslip.

🟢 READ-ONLY · returns a PDF · Payslips · GET /payslips/{id}/download/

Download payslip PDF

Endpoint for downloading a PDF of the payslip.

Returns the document as base64-encoded PDF bytes plus its size and content type. Nothing is modified.

🟢 READ-ONLY · Pay Items · GET /payslips/{payslip_id}/pay-items/

List pay items

Endpoint for retrieving a list of pay items.

🟡 WRITE · creates data · Pay Items · POST /payslips/{payslip_id}/pay-items/

Create pay item

Endpoint for creating a new pay item.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Pay Items · GET /payslips/{payslip_id}/pay-items/{id}/

Retrieve pay item

Endpoint for retrieving a single pay item.

🟡 WRITE · updates data · Pay Items · PUT /payslips/{payslip_id}/pay-items/{id}/

Update pay item

Endpoint for updating an existing pay item.

🔴 DESTRUCTIVE · deletes · Pay Items · DELETE /payslips/{payslip_id}/pay-items/{id}/

Delete pay item

Endpoint for deleting an existing pay item.

Permanently removes the record.

🟡 WRITE · updates data · Pay Items · PATCH /payslips/{payslip_id}/pay-items/{id}/

Partial update pay item

Endpoint for partially updating an existing pay item.

🟢 READ-ONLY · Projects · GET /projects/

List projects

Endpoint for retrieving a list of projects.

🟡 WRITE · creates data · Projects · POST /projects/

Create project

Endpoint for creating a new project.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Projects · GET /projects/{id}/

Retrieve project

Endpoint for retrieving a single project.

🟡 WRITE · updates data · Projects · PUT /projects/{id}/

Update project

Endpoint for updating an existing project.

🔴 DESTRUCTIVE · deletes · Projects · DELETE /projects/{id}/

Delete project

Endpoint for deleting an existing project.

Permanently removes the record.

🟡 WRITE · updates data · Projects · PATCH /projects/{id}/

Partial update project

Endpoint for partially updating an existing project.

🟢 READ-ONLY · Purchase Orders · GET /purchase-orders/

List purchase orders

Endpoint for retrieving a list of purchase orders.

🟡 WRITE · creates data · Purchase Orders · POST /purchase-orders/

Create purchase order

Endpoint for creating a new purchase order.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Purchase Orders · GET /purchase-orders/{id}/

Retrieve purchase order

Endpoint for retrieving a single purchase order.

🟡 WRITE · updates data · Purchase Orders · PUT /purchase-orders/{id}/

Update purchase order

Endpoint for updating an existing purchase order.

🔴 DESTRUCTIVE · deletes · Purchase Orders · DELETE /purchase-orders/{id}/

Delete purchase order

Endpoint for deleting an existing purchase order.

Permanently removes the record.

🟡 WRITE · updates data · Purchase Orders · PATCH /purchase-orders/{id}/

Partial update purchase order

Endpoint for partially updating an existing purchase order.

🟡 WRITE · creates data · Purchase Orders · POST /purchase-orders/{id}/bill/

Convert purchase order to bill

This endpoint can be used to convert a purchase order to a draft bill.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

Creates a NEW draft bill from the purchase order. Calling twice creates two bills — pass an idempotency_key if you may retry.

🟢 READ-ONLY · returns a PDF · Purchase Orders · GET /purchase-orders/{id}/download/

Download purchase order PDF

Endpoint for downloading a PDF of the purchase order.

Returns the document as base64-encoded PDF bytes plus its size and content type. Nothing is modified.

🟢 READ-ONLY · Purchase Order Line Items · GET /purchase-orders/{purchase_order_id}/line-items/

List purchase order line items

Endpoint for retrieving a list of purchase order line items.

🟡 WRITE · creates data · Purchase Order Line Items · POST /purchase-orders/{purchase_order_id}/line-items/

Create purchase order line item

Endpoint for creating a new purchase order line item.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Purchase Order Line Items · GET /purchase-orders/{purchase_order_id}/line-items/{id}/

Retrieve purchase order line item

Endpoint for retrieving a single purchase order line item.

🟡 WRITE · updates data · Purchase Order Line Items · PUT /purchase-orders/{purchase_order_id}/line-items/{id}/

Update purchase order line item

Endpoint for updating an existing purchase order line item.

🔴 DESTRUCTIVE · deletes · Purchase Order Line Items · DELETE /purchase-orders/{purchase_order_id}/line-items/{id}/

Delete purchase order line item

Endpoint for deleting an existing purchase order line item.

Permanently removes the record.

🟡 WRITE · updates data · Purchase Order Line Items · PATCH /purchase-orders/{purchase_order_id}/line-items/{id}/

Partial update purchase order line item

Endpoint for partially updating an existing purchase order line item.

🟢 READ-ONLY · Quotes · GET /quotes/

List quotes

Endpoint for retrieving a list of quotes.

🟡 WRITE · creates data · Quotes · POST /quotes/

Create quote

Endpoint for creating a new quote.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Quotes · GET /quotes/{id}/

Retrieve quote

Endpoint for retrieving a single quote.

🟡 WRITE · updates data · Quotes · PUT /quotes/{id}/

Update quote

Endpoint for updating an existing quote.

🔴 DESTRUCTIVE · deletes · Quotes · DELETE /quotes/{id}/

Delete quote

Endpoint for deleting an existing quote.

Permanently removes the record.

🟡 WRITE · updates data · Quotes · PATCH /quotes/{id}/

Partial update quote

Endpoint for partially updating an existing quote.

🟢 READ-ONLY · returns a PDF · Quotes · GET /quotes/{id}/download/

Download quote PDF

Endpoint for downloading a PDF of the quote.

Returns the document as base64-encoded PDF bytes plus its size and content type. Nothing is modified.

🟡 WRITE · creates data · Quotes · POST /quotes/{id}/invoice/

Convert quote to invoice

This endpoint can be used to convert a quote to an invoice.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

Creates a NEW invoice from the quote. Calling twice creates two invoices — pass an idempotency_key if you may retry.

🟢 READ-ONLY · Quote Line Items · GET /quotes/{quote_id}/line-items/

List quote line items

Endpoint for retrieving a list of quote line items.

🟡 WRITE · creates data · Quote Line Items · POST /quotes/{quote_id}/line-items/

Create quote line item

Endpoint for creating a new quote line item.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Quote Line Items · GET /quotes/{quote_id}/line-items/{id}/

Retrieve quote line item

Endpoint for retrieving a single quote line item.

🟡 WRITE · updates data · Quote Line Items · PUT /quotes/{quote_id}/line-items/{id}/

Update quote line item

Endpoint for updating an existing quote line item.

🔴 DESTRUCTIVE · deletes · Quote Line Items · DELETE /quotes/{quote_id}/line-items/{id}/

Delete quote line item

Endpoint for deleting an existing quote line item.

Permanently removes the record.

🟡 WRITE · updates data · Quote Line Items · PATCH /quotes/{quote_id}/line-items/{id}/

Partial update quote line item

Endpoint for partially updating an existing quote line item.

🟢 READ-ONLY · Reports · GET /reports/balance-sheet/

Balance Sheet

Generate balance sheet report in currency at date with period_count periods to compare and group it by group_by parameter.

PARAMETERS: this report takes date (the 'as of' date) and period_count (0-11 extra comparison periods) — both REQUIRED. It does NOT take a date range; there is no date_from/date_to/date_after/date_before. group_by (month|year) sets the size of the comparison periods.

🟢 READ-ONLY · Reports · GET /reports/cash-flow/

Cash Flow

Generate cash flow report in currency from date_after to date_before range and group it by group_by parameter.

PARAMETERS: date_after and date_before are both REQUIRED and are the range bounds. There is no date_from/date_to. The same whole-period rule as profit-and-loss applies and is checked before sending.

🟢 READ-ONLY · Reports · GET /reports/profit-and-loss/

Profit and Loss

Generate profit and loss report in currency from date_after to date_before range and group it by group_by parameter.

PARAMETERS: date_after and date_before are both REQUIRED and are the range bounds. There is no date_from/date_to. The range must cover whole periods: with group_by=month (the default) it must run from the first day of a month to the last day of a month; with group_by=year it must run 1 January to 31 December. A partial year with group_by=year is rejected — use group_by=month for a year-to-date figure. This server checks the range before sending and tells you the nearest valid one.

🟢 READ-ONLY · Reports · GET /reports/trial-balance/

Trial Balance

Generate trial balance report from from_date to to_date optionally with PNL openings with_pnl_openings and accounts with zero balances include_zero_balances.

PARAMETERS: this report uses from_date and to_date (NOT date_after/date_before, and NOT date_from/date_to). Both are optional; omitting them returns the current financial year. Verified 2026-09-04: the dates ARE honoured when spelled correctly — a narrower range returns a smaller report. Wafeq silently ignores misspelled query parameters rather than erroring, so a wrong name looks like a working call that returns the default period.

🟢 READ-ONLY · Revenue Recognitions · GET /revenue-recognitions/

List revenue recognitions

Endpoint for retrieving a list of revenue recognitions.

🟢 READ-ONLY · preview / simulation · Revenue Recognitions · POST /revenue-recognitions/preview/

Preview revenue recognition schedule

Endpoint for previewing the revenue recognition events that would be generated for the given schedule, without creating a revenue recognition.

This is a POST, but Wafeq documents it as a simulation: it returns the events that WOULD be generated and writes nothing to the ledger.

🟢 READ-ONLY · Revenue Recognitions · GET /revenue-recognitions/{id}/

Retrieve revenue recognition

Endpoint for retrieving a single revenue recognition.

🔴 DESTRUCTIVE · deletes · Revenue Recognitions · DELETE /revenue-recognitions/{id}/

Delete revenue recognition

Endpoint for deleting an existing revenue recognition.

Permanently removes the record.

🔴 IRREVERSIBLE · posts the remaining balance to the ledger · Revenue Recognitions · POST /revenue-recognitions/{id}/end-early/

End revenue recognition early

Endpoint for terminating a revenue recognition early, recognizing the remaining balance against the provided account.

Terminates a schedule early and recognizes its whole remaining balance immediately. There is no API undo. Run the matching preview_... tool first to see exactly what would be posted.

🟢 READ-ONLY · preview / simulation · Revenue Recognitions · POST /revenue-recognitions/{id}/preview-end-early/

Preview early termination

Endpoint for previewing the remaining balance and the posted events that would be reversed by terminating the revenue recognition early at the given date.

This is a POST, but Wafeq documents it as a simulation: it returns the events that WOULD be generated and writes nothing to the ledger.

🟢 READ-ONLY · Simplified Invoices · GET /simplified-invoices/

List simplified invoices

Endpoint for retrieving a list of simplified invoices.

🟡 WRITE · creates data · Simplified Invoices · POST /simplified-invoices/

Create simplified invoice

Endpoint for creating a new simplified invoice.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Simplified Invoices · GET /simplified-invoices/{id}/

Retrieve simplified invoice

Endpoint for retrieving a single simplified invoice.

🟡 WRITE · updates data · Simplified Invoices · PUT /simplified-invoices/{id}/

Update simplified invoice

Endpoint for updating an existing simplified invoice.

🔴 DESTRUCTIVE · deletes · Simplified Invoices · DELETE /simplified-invoices/{id}/

Delete simplified invoice

Endpoint for deleting an existing simplified invoice.

Permanently removes the record.

🟡 WRITE · updates data · Simplified Invoices · PATCH /simplified-invoices/{id}/

Partial update simplified invoice

Endpoint for partially updating an existing simplified invoice.

🟢 READ-ONLY · returns a PDF · Simplified Invoices · GET /simplified-invoices/{id}/download/

Download simplified invoice PDF

Endpoint for downloading a PDF of the simplified invoice.

Returns the document as base64-encoded PDF bytes plus its size and content type. Nothing is modified.

🔴 IRREVERSIBLE · files the document with an external tax authority · Simplified Invoices · POST /simplified-invoices/{id}/tax-authority/report/

Report simplified invoice to tax authority

Report the simplified invoice to the tax authority for processing and validation.

Submits the document outside your organization for clearance/reporting. It CANNOT be recalled or undone through this API. Confirm with the user before calling, and check the document's contents first.

🟢 READ-ONLY · Simplified Invoice Line Items · GET /simplified-invoices/{invoice_id}/line-items/

List simplified invoice line items

Endpoint for retrieving a list of simplified invoice line items.

🟡 WRITE · creates data · Simplified Invoice Line Items · POST /simplified-invoices/{invoice_id}/line-items/

Create simplified invoice line item

Endpoint for creating a new simplified invoice line item.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Simplified Invoice Line Items · GET /simplified-invoices/{invoice_id}/line-items/{id}/

Retrieve simplified invoice line item

Endpoint for retrieving a single simplified invoice line item.

🟡 WRITE · updates data · Simplified Invoice Line Items · PUT /simplified-invoices/{invoice_id}/line-items/{id}/

Update simplified invoice line item

Endpoint for updating an existing simplified invoice line item.

🔴 DESTRUCTIVE · deletes · Simplified Invoice Line Items · DELETE /simplified-invoices/{invoice_id}/line-items/{id}/

Delete simplified invoice line item

Endpoint for deleting an existing simplified invoice line item.

Permanently removes the record.

🟡 WRITE · updates data · Simplified Invoice Line Items · PATCH /simplified-invoices/{invoice_id}/line-items/{id}/

Partial update simplified invoice line item

Endpoint for partially updating an existing simplified invoice line item.

🟢 READ-ONLY · Tax Rates · GET /tax-rates/

List tax rates

Endpoint for retrieving a list of tax rates.

🟢 READ-ONLY · Unit Of Measures · GET /units-of-measure/

List unit of measures

Endpoint for retrieving a list of unit of measures.

🟡 WRITE · creates data · Unit Of Measures · POST /units-of-measure/

Create unit of measure

Endpoint for creating a new unit of measure.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Unit Of Measures · GET /units-of-measure/{id}/

Retrieve unit of measure

Endpoint for retrieving a single unit of measure.

🟡 WRITE · updates data · Unit Of Measures · PUT /units-of-measure/{id}/

Update unit of measure

Endpoint for updating an existing unit of measure.

🔴 DESTRUCTIVE · deletes · Unit Of Measures · DELETE /units-of-measure/{id}/

Delete unit of measure

Endpoint for deleting an existing unit of measure.

Permanently removes the record.

🟡 WRITE · updates data · Unit Of Measures · PATCH /units-of-measure/{id}/

Partial update unit of measure

Endpoint for partially updating an existing unit of measure.

🟢 READ-ONLY · Warehouses · GET /warehouses/

List warehouses

Endpoint for retrieving a list of warehouses.

🟡 WRITE · creates data · Warehouses · POST /warehouses/

Create warehouse

Endpoint for creating a new warehouse.

Not idempotent — calling twice creates two records. Pass idempotency_key (or let the server generate one) to make a retry safe.

🟢 READ-ONLY · Warehouses · GET /warehouses/{id}/

Retrieve warehouse

Endpoint for retrieving a single warehouse.

🟡 WRITE · updates data · Warehouses · PUT /warehouses/{id}/

Update warehouse

Endpoint for updating an existing warehouse.

🔴 DESTRUCTIVE · deletes · Warehouses · DELETE /warehouses/{id}/

Delete warehouse

Endpoint for deleting an existing warehouse.

Permanently removes the record.

🟡 WRITE · updates data · Warehouses · PATCH /warehouses/{id}/

Partial update warehouse

Endpoint for partially updating an existing warehouse.

🟢 READ-ONLY · Journal Line Items · convenience tool

List journal line items WITH their real transaction date attached as date.

Use this instead of the raw journal-line-items tool whenever the date matters — for tracing an account's history, reconciling a period, or explaining a balance. The raw endpoint returns created_ts (when the row reached Wafeq), which is regularly a different month from the transaction and must not be reported as the transaction date.

Both dates are required and the window must be 92 days or fewer for dates to be resolved; a wider range still returns rows, but without date. Costs one request per month plus one per day in months that contain rows, so quiet periods are cheap. The result reports requests_made.

🔴 DESTRUCTIVE · arbitrary API call · Escape hatch · any method, any path

Call any Wafeq endpoint directly, with full control over method, path, query, body AND headers.

This is the FALLBACK, not the primary interface: every documented endpoint already has its own generated tool with a correct input schema and an accurate safety category. Reach for this only for something the bundled spec does not cover.

It is categorized destructive because the effect cannot be known in advance — the same tool can read a report or delete an invoice. Confirm with the user before any non-GET call.

Writes get an automatic X-Wafeq-Idempotency-Key unless you supply one in headers. Authorization is always set from the server's own credentials and cannot be overridden.