Skip to main content
POST
/
documents
/
{document_id}
/
credit-note
Create Credit Note
curl --request POST \
  --url http://localhost:8000/documents/{document_id}/credit-note \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>",
  "lines": [
    {
      "line_number": 2,
      "description": "<string>",
      "quantity": 1,
      "unit_price": 1,
      "subtotal": 1,
      "tax_rate_code": "<string>",
      "main_code": "<string>",
      "aux_code": "<string>",
      "discount": "0.00",
      "tax_code": "2"
    }
  ],
  "taxes": [
    {
      "tax_code": "<string>",
      "tax_rate_code": "<string>",
      "taxable_base": 1,
      "rate": 0.5,
      "tax_amount": 1
    }
  ],
  "subtotal": 123,
  "total_tax": 123,
  "total": 123,
  "issue_date": "2023-12-25",
  "total_discount": "0.00",
  "idempotency_key": "<string>"
}
'
{
  "credit_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "original_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "access_key": "<string>"
}

Headers

authorization
string | null
x-api-key
string | null
x-tenant-id
string | null

Path Parameters

document_id
string<uuid>
required

Cookies

factio_access_token
string | null

Body

application/json
reason
string
required
Required string length: 1 - 500
lines
DocumentLineCreate · object[]
required
taxes
DocumentTaxCreate · object[]
required
subtotal
required
total_tax
required
total
required
issue_date
string<date>
required
total_discount
default:0.00
idempotency_key
string | null

Response

Successful Response

credit_note_id
string<uuid>
required
original_document_id
string<uuid>
required
status
string
required
access_key
string | null
required