Rekaz Documentation
  • 鉀╋笍Introduction
  • 馃殌Quick Start
  • 馃捇API Reference
    • Subscription
      • Usage list
      • Usage
      • End usage
    • Customer
    • Invoice
      • Pay
      • Cancel
      • Print
    • Product
  • Webhooks
Powered by GitBook
On this page
  1. API Reference

Invoice

Last updated 1 year ago

馃捇
get

/api/app/invoice

Query parameters
CustomerIdstring 路 uuid
Statusinteger 路 enum
Options: 1, 2, 3, 4
Sortingstring
SkipCountinteger 路 int32 路 max: 2147483647
MaxResultCountinteger 路 int32 路 min: 1 路 max: 2147483647
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/app/invoice'
200
400
401
403
404
500
501
text/plain
application/json
text/json
{
  "totalCount": 1,
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "2025-02-20T19:23:21.880Z",
      "creatorId": "123e4567-e89b-12d3-a456-426614174000",
      "lastModificationTime": "2025-02-20T19:23:21.880Z",
      "lastModifierId": "123e4567-e89b-12d3-a456-426614174000",
      "isDeleted": true,
      "deleterId": "123e4567-e89b-12d3-a456-426614174000",
      "deletionTime": "2025-02-20T19:23:21.880Z",
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "customerName": "text",
      "customerMobile": "text",
      "customerAddress": "text",
      "customerCrNumber": "text",
      "customerVatNumber": "text",
      "branchId": "123e4567-e89b-12d3-a456-426614174000",
      "branchName": "text",
      "price": 1,
      "paidAmount": 1,
      "totalPrice": 1,
      "remainingAmount": 1,
      "url": "text",
      "status": 1,
      "statusString": "text",
      "code": "text",
      "discount": 1,
      "vatAmount": 1,
      "priceWitoutVat": 1,
      "businessInfo": {
        "crNumber": "text",
        "commercialName": "text",
        "vatNumber": "text",
        "address": "text",
        "logo": "text"
      },
      "crNumber": "text",
      "commercialName": "text",
      "vatNumber": "text",
      "address": "text",
      "logo": "text",
      "notes": "text",
      "items": [
        {
          "quantity": 1,
          "price": 1,
          "totalPrice": 1,
          "totalNet": 1,
          "discount": 1,
          "name": "text",
          "description": "text",
          "type": 1,
          "reference": "text",
          "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
          "vatPercentage": 1,
          "vatAmount": 1
        }
      ]
    }
  ]
}

Success

post

/api/app/invoice

Body
customerIdstring 路 uuid
pricenumber 路 double
vatAmountnumber 路 double
branchIdstring 路 uuid
invoiceItemsobject[] | nullable
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/api/app/invoice' \
  --header 'Content-Type: application/json' \
  --data '{"invoiceItems":[{"type":1}]}'
200
400
401
403
404
500
501
No body

Success

get

/api/app/invoice/{id}

Path parameters
idstring 路 uuidrequired
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/app/invoice/{id}'
200
400
401
403
404
500
501
text/plain
application/json
text/json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "creationTime": "2025-02-20T19:23:21.880Z",
  "creatorId": "123e4567-e89b-12d3-a456-426614174000",
  "lastModificationTime": "2025-02-20T19:23:21.880Z",
  "lastModifierId": "123e4567-e89b-12d3-a456-426614174000",
  "isDeleted": true,
  "deleterId": "123e4567-e89b-12d3-a456-426614174000",
  "deletionTime": "2025-02-20T19:23:21.880Z",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "customerName": "text",
  "customerMobile": "text",
  "customerAddress": "text",
  "customerCrNumber": "text",
  "customerVatNumber": "text",
  "branchId": "123e4567-e89b-12d3-a456-426614174000",
  "branchName": "text",
  "price": 1,
  "paidAmount": 1,
  "totalPrice": 1,
  "remainingAmount": 1,
  "url": "text",
  "status": 1,
  "statusString": "text",
  "code": "text",
  "discount": 1,
  "vatAmount": 1,
  "priceWitoutVat": 1,
  "businessInfo": {
    "crNumber": "text",
    "commercialName": "text",
    "vatNumber": "text",
    "address": "text",
    "logo": "text"
  },
  "crNumber": "text",
  "commercialName": "text",
  "vatNumber": "text",
  "address": "text",
  "logo": "text",
  "notes": "text",
  "items": [
    {
      "quantity": 1,
      "price": 1,
      "totalPrice": 1,
      "totalNet": 1,
      "discount": 1,
      "name": "text",
      "description": "text",
      "type": 1,
      "reference": "text",
      "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
      "vatPercentage": 1,
      "vatAmount": 1
    }
  ]
}

Success

  • GET/api/app/invoice
  • POST/api/app/invoice
  • GET/api/app/invoice/{id}