API Docs

Edit and resubmit a purchase credit note

Updates and resubmits a specific purchase credit note after fixing validation issues.

Rate limit

60 requests/minute per authenticated account. See Rate limiting for response headers (X-RateLimit-*) and retry guidance.

Path parameters

Request body

Resubmit requires the complete purchase credit note JSON — send the full document payload again, not a partial patch. Include every root-level field you would send on create; corrected values replace the stored document. Omitting fields may clear or reset them.

Request fields

Fields in the request JSON. Rows are ordered Required → Conditional → Optional. The Required column shows whether each field is always needed, sometimes needed, or optional. Object fields have dedicated sections further down this page.

Do not send: accounting_customer_party — the API sets the customer from {profileId}. Do not send calculated or system fields (id, org_id, document_sequence, totals, meta_info, etc.) — those appear in the response only.

Field	Type	Required	Description	Validation
`profile_execution_id`	string	Required	Credit note transaction type code.	Exactly 8 characters; each character `0` or `1`. See Profile execution ID section for details.
`issue_date`	string	Required	The date when the credit note was issued.	Format `yyyy-MM-dd`; must be a valid calendar date.
`credit_note_type_code`	string	Required	The type of credit note.	For purchase credit notes this code must be `261` (Self-billed Credit Note).
`discrepancy_response`	string	Required	Reason for issuing the credit note per UAE FTA DL8.61.1.	Must be one of the allowed discrepancy codes.
`document_currency_code`	string	Required	ISO 4217 alpha-3 currency code for all monetary amounts.	Must be a valid ISO 4217 code. For non-AED documents, see Non-AED credit notes.
`accounting_supplier_party`	object	Required	The supplier party for the credit note.	Must be a valid party object. See Supplier party object section for details.
`document_lines`	array	Required	Credit note line items.	At least one line required.
`billing_reference`	array	Required	Billing references to the original invoice being credited.	At least one reference required on create; each item requires `id`.
`document_number`	string	Conditional	The credit note number as displayed on the document.	Required when auto-numbering is disabled; auto-generated when enabled and omitted. Recommendation: provide explicitly for ERP reconciliation.
`tax_point_date`	string	Conditional	Tax point date per UAE VAT Law.	If present: format `yyyy-MM-dd`; must be on or before `issue_date`. See Tax point date (UAE VAT) section for details.
`tax_currency_code`	string	Conditional	ISO 4217 currency code for tax amounts.	Required when `document_currency_code` is not `AED`—must be `AED`. See Non-AED credit notes section for details.
`tax_exchange_rate`	object	Conditional	Exchange rate for tax calculation in AED.	Required when `document_currency_code` is not `AED`.
`buyer_customer_party`	object	Conditional	Beneficiary ID (UBL `BTAE-01`).	Required for Free Trade Zone (FTZ). See Buyer customer party object section for details.
`seller_supplier_party`	object	Conditional	Principle ID (UBL `BTAE-14`).	Required for Disclosed Agent Billing. See Seller supplier party object section for details.
`delivery`	object	Conditional	Delivery details.	Required for Exports. See Delivery object section for details.
`invoice_period`	object	Conditional	Period covered by the credited supply.	Required for Summary invoice.
`issue_time`	string	Optional	The time when the credit note was issued.	Format `HH:mm:ss`. GST (UTC+4). Defaults to `00:00:00` when omitted.
`reason`	string	Optional	Free-text explanation for the credit note.	Free text.
`note`	string	Optional	Additional notes on the credit note.	Free text.
`accounting_cost`	string	Optional	Accounting cost center identifier.	Free text.
`buyer_reference`	string	Optional	Buyer reference for the credit note.	Free text.
`order_reference`	object	Optional	Reference to the original order.	If present: `id` required.
`despatch_document_reference`	object	Optional	Reference to despatch document.	If present: `id` required.
`receipt_document_reference`	object	Optional	Reference to receipt document.	If present: `id` required.
`statement_document_reference`	object	Optional	Reference to statement document.	If present: `id` required.
`originator_document_reference`	object	Optional	Reference to originating document.	If present: `id` required.
`contract_document_reference`	object	Optional	Reference to contract.	If present: `id` required.
`payee_party`	object	Optional	Party to whom payment/refund should be made.	If present, see Payee party object.
`tax_representative_party`	object	Optional	Tax representative party.	If present, see Tax representative party object.
`payment_terms`	object	Optional	Payment terms and conditions.	If present, see Payment terms object.
`charges`	array	Optional	Document-level charges.	If present, see Charge object.
`allowances`	array	Optional	Document-level discounts/allowances.	If present, see Allowance object.
`prepaid_amount`	number	Optional	Total prepaid amount applied.	Typically non-negative.
`payable_rounding_amount`	number	Optional	Rounding adjustment.	May be positive or negative.
`document_source`	string	Optional	Origin of the e-invoice document.	Defaults to `API` when omitted.
`attachments`	array	Optional	Supporting documents.	See Attachment object (request) section for details. Max 8 MB body.

Conditional field rules

Condition	Affected fields	Rule
Free Trade Zone (FTZ)	`buyer_customer_party.id`	Required — valid Beneficiary TIN.
Summary invoice	`invoice_period`	`start_date`, `end_date`, and `description` required.
Disclosed Agent Billing	`seller_supplier_party.id`	Required — valid Principle ID TRN.
Exports	`delivery`	Required with `delivery_location.address`.
`document_currency_code` ≠ `AED`	`tax_currency_code`, `tax_exchange_rate`	See Non-AED credit notes section for details.
Credit note create	`billing_reference`	At least one reference to the original invoice required.

Response meta_info object

The meta_info field is an object with the following attributes:

Field	Type	Required	Description	Validation
`peppol_status`	object	Optional	Peppol participant/FTA processing status.	Response-only; see Peppol status object below.

Peppol status object

The meta_info.peppol_status field is an object with the following attributes:

Field	Type	Required	Description	Validation
`participant_status`	string	Optional	Participant-level processing status.	Must be one of the status values listed below.
`fta_status`	string	Optional	FTA submission/processing status.	Must be one of the status values listed below.
`overall_status`	string	Optional	Overall Peppol processing status.	Must be one of the status values listed below.
`validation_results`	array	Optional	Validation details/errors returned during processing.	Response-only list; empty when there are no validation issues.

Status values

Value	Meaning
`VALIDATION_FAILED`	The received document failed validation checks.
`PENDING`	Processing is in progress.
`APPROVED`	The document is accepted.
`REJECTED`	The document is processed but rejected.

Client processing guidance:

Treat overall_status as the primary state for workflow decisions.
Use participant_status and fta_status as stage-specific diagnostics for UI and support logs.
If overall_status is PENDING, keep the credit note in a processing state and poll/re-fetch later.
If overall_status is APPROVED, mark the Peppol flow as successful and continue normal downstream actions.
If overall_status is REJECTED or VALIDATION_FAILED, stop submission-dependent actions and surface the failure to users.
When validation_results is not empty, display user-friendly error summaries from text, and retain flag, reasonCode, location, and test for troubleshooting.
participant_status or fta_status can be null in early/failed validation stages; do not treat null alone as success or failure.

Resubmit condition

Resubmit is allowed only when:

meta_info.peppol_status.overall_status = VALIDATION_FAILED

Attachments

Each attachments item requires file_name, file_type, and Base64 file_content. On resubmit:

Omit attachments to keep the existing attachment set unchanged.
Send attachments to replace the full set (client uploads are re-persisted).

The response attachments array includes id, file_name, and file_type only. The create-only 8MB payload limit does not apply to this PUT endpoint.

Error responses

Status	Description
400 Bad Request	Resubmit is not allowed while the document is still pending.
401 Unauthorized	Authentication required or invalid token.
404 Not Found	Purchase credit note not found, or business profile not found.
500 Internal Server Error	An error occurred while processing the request.

{
  "errors": {
    "document_status": "document status is still pending state you cannot resubmit"
  }
}

{
  "errors": {
    "message": "Business profile not found with id: {business_profile_id}"
  }
}