Invoice

GET/api/app/invoice

Query parameters

Response

200400401403404500501

Success

Body

text/plainapplication/jsontext/json

itemsnullable array of Snam.Platform.Invoices.Dtos.InvoiceDto (object)

totalCountinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('/api/app/invoice', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500501

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "2024-11-27T19:49:01.644Z",
      "creatorId": "123e4567-e89b-12d3-a456-426614174000",
      "lastModificationTime": "2024-11-27T19:49:01.644Z",
      "lastModifierId": "123e4567-e89b-12d3-a456-426614174000",
      "isDeleted": false,
      "deleterId": "123e4567-e89b-12d3-a456-426614174000",
      "deletionTime": "2024-11-27T19:49:01.644Z",
      "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": 0,
      "paidAmount": 0,
      "totalPrice": 0,
      "remainingAmount": 0,
      "url": "text",
      "status": 1,
      "statusString": "text",
      "code": "text",
      "discount": 0,
      "vatAmount": 0,
      "priceWitoutVat": 0,
      "items": [
        {
          "quantity": 0,
          "price": 0,
          "totalPrice": 0,
          "totalNet": 0,
          "discount": 0,
          "name": "text",
          "description": "text",
          "type": 1,
          "reference": "text",
          "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
          "vatPercentage": 0,
          "vatAmount": 0
        }
      ],
      "businessInfo": {
        "crNumber": "text",
        "commercialName": "text",
        "vatNumber": "text",
        "address": "text",
        "logo": "Ynl0ZXM="
      },
      "crNumber": "text",
      "commercialName": "text",
      "vatNumber": "text",
      "address": "text",
      "logo": "text",
      "notes": "text"
    }
  ]
}

POST/api/app/invoice

Body

application/jsontext/jsonapplication/*+json

customerIdstring (uuid)

pricenumber (double)

vatAmountnumber (double)

invoiceItemsnullable array of Snam.Platform.Invoices.Dtos.InvoiceItemDto (object)

branchIdstring (uuid)

Response

200400401403404500501

Success

Request

JavaScriptCurlPython

const response = await fetch('/api/app/invoice', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404500501

{
  "error": {
    "code": "text",
    "message": "text",
    "details": "text",
    "validationErrors": [
      {
        "message": "text",
        "members": [
          "text"
        ]
      }
    ]
  }
}

GET/api/app/invoice/{id}

Path parameters

id*string (uuid)

Response

200400401403404500501

Success

Body

text/plainapplication/jsontext/json

idstring (uuid)

creationTimestring (date-time)

creatorIdnullable string (uuid)

lastModificationTimenullable string (date-time)

lastModifierIdnullable string (uuid)

isDeletedboolean

deleterIdnullable string (uuid)

deletionTimenullable string (date-time)

customerIdstring (uuid)

customerNamenullable string

customerMobilenullable string

customerAddressnullable string

customerCrNumbernullable string

customerVatNumbernullable string

branchIdstring (uuid)

branchNamenullable string

pricenumber (double)

paidAmountnumber (double)

totalPricenumber (double)

remainingAmountnumber (double)

urlnullable string

statusSnam.Platform.Invoices.InvoiceStatus (enum)

1234

statusStringnullable string

codenullable string

discountnumber (double)

vatAmountnumber (double)

priceWitoutVatnumber (double)

itemsnullable array of Snam.Platform.Invoices.Dtos.InvoiceItemDto (object)

businessInfoSnam.Platform.Invoices.Dtos.InvoiceBusinessInfoDto (object)

crNumbernullable string

commercialNamenullable string

vatNumbernullable string

addressnullable string

logonullable string

notesnullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/app/invoice/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500501

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "creationTime": "2024-11-27T19:49:01.644Z",
  "creatorId": "123e4567-e89b-12d3-a456-426614174000",
  "lastModificationTime": "2024-11-27T19:49:01.644Z",
  "lastModifierId": "123e4567-e89b-12d3-a456-426614174000",
  "isDeleted": false,
  "deleterId": "123e4567-e89b-12d3-a456-426614174000",
  "deletionTime": "2024-11-27T19:49:01.644Z",
  "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": 0,
  "paidAmount": 0,
  "totalPrice": 0,
  "remainingAmount": 0,
  "url": "text",
  "status": 1,
  "statusString": "text",
  "code": "text",
  "discount": 0,
  "vatAmount": 0,
  "priceWitoutVat": 0,
  "items": [
    {
      "quantity": 0,
      "price": 0,
      "totalPrice": 0,
      "totalNet": 0,
      "discount": 0,
      "name": "text",
      "description": "text",
      "type": 1,
      "reference": "text",
      "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
      "vatPercentage": 0,
      "vatAmount": 0
    }
  ],
  "businessInfo": {
    "crNumber": "text",
    "commercialName": "text",
    "vatNumber": "text",
    "address": "text",
    "logo": "Ynl0ZXM="
  },
  "crNumber": "text",
  "commercialName": "text",
  "vatNumber": "text",
  "address": "text",
  "logo": "text",
  "notes": "text"
}