GET /purchase/receipts

GET 
/purchase/receipts

GET /purchase/receipts

Request

Query Parameters

id int64[]
date_issued string

Custom date range syntax. Equal: 2020-01-01; From: [2020-01-01;]; To: [;2025-12-31]; Between: [2020-01-01;2025-12-31]. Custom date range syntax. Equal: 2020-01-01; From: [2020-01-01;]; To: [;2025-12-31]; Between: [2020-01-01;2025-12-31].

total_amount string

Custom decimal range syntax. Equal: 100.50; From: [100.50;]; To: [;500.00]; Between: [100.50;500.00]. Custom decimal range syntax. Equal: 100.50; From: [100.50;]; To: [;500.00]; Between: [100.50;500.00].

vendor_receipt_no string[]
vendor.id int64
vendor.business_name string
vendor.display_name string
vendor.reg_no string
vendor.vat_no string
vendor.tax_no string
vendor.address.name string
vendor.address.company string
vendor.address.address1 string
vendor.address.address2 string
vendor.address.postal_code string
vendor.address.city string
vendor.address.region string
vendor.address.country string

Possible values: <= 2 characters

vendor.email string
vendor.preferred_locale string
vendor.phone string
is_locked boolean
description string
currency string
transaction_type.id int64
transaction_type.name string
transaction_type.associated_payment_cards string[]
from int32
take int32
search string
sort string[]

Responses

200

OK

text/plain

Schema

Schema

total int64nullable
from int64nullable
take int64nullable

entities

object[]

nullable

Array [

id int64nullable

uid uuidnullable

created_at date-timenullable

edited_at date-timenullable

is_locked boolean

no stringnullable

vendor_receipt_no stringnullable

vendor

object

id int64nullable

business_name stringnullable

display_name stringnullable

reg_no stringnullable

vat_no stringnullable

tax_no stringnullable

address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

email stringnullable

preferred_locale stringnullable

phone stringnullable

culture stringnullable

date_issued datenullable

description stringnullable

currency stringnullable

precision int32nullable

Default value: 2

rate_format stringnullable

taxes_included boolean

tax_deduction_ratio doublenullable

net_deduction_ratio doublenullable

transaction_type

object

id int32nullable

name stringnullable

associated_payment_cards string[]nullable

tax_nexus

object

id int32nullable

code stringnullable

currency stringnullable

taxes

object[]

nullable

Array [

index int64nullable

code stringnullable

name stringnullable

currency stringnullable

rate_type stringnullable

is_implicit boolean

rates

object[]

nullable

Array [

rate double

is_default boolean

]

]

jurisdiction

object

country stringnullable

region stringnullable

subregion stringnullable

city stringnullable

postal_code stringnullable

registration_mode stringnullable

total_amount doublenullable

subtotal_amount doublenullable

copy_from_id int64nullable

taxes

object[]

nullable

Array [

id int64nullable

tax_index int32nullable

tax_rate doublenullable

tax_amount doublenullable

tax_base doublenullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

items

object[]

nullable

Array [

id int64nullable

description stringnullable

qty double

rate doublenullable

rate_discounted doublenullable

discount_explicit doublenullable

discount_implicit doublenullable

amount doublenullable

payment_amount doublenullable

currency stringnullable

tax_deduction_ratio doublenullable

net_deduction_ratio doublenullable

item

object

id int64

code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

desc_org stringnullable

desc_leg stringnullable

desc stringnullable

unit

object

id int32nullable

unece_code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

paid_record

object

id int64nullable

no stringnullable

type stringnullable

contact

object

id int64nullable

business_name stringnullable

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_base doublenullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

]

rsn stringnullable

]

aggregations undefined[]nullable

Example (from schema)

{
  "total": 0,
  "from": 0,
  "take": 0,
  "entities": [
    {
      "id": 0,
      "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "2024-07-29T15:51:28.071Z",
      "edited_at": "2024-07-29T15:51:28.071Z",
      "is_locked": true,
      "no": "string",
      "vendor_receipt_no": "string",
      "vendor": {
        "id": 0,
        "business_name": "string",
        "display_name": "string",
        "reg_no": "string",
        "vat_no": "string",
        "tax_no": "string",
        "address": {
          "name": "string",
          "company": "string",
          "address1": "string",
          "address2": "string",
          "postal_code": "string",
          "city": "string",
          "region": "string",
          "country": "string"
        },
        "email": "string",
        "preferred_locale": "string",
        "phone": "string"
      },
      "culture": "string",
      "date_issued": "2024-07-29",
      "description": "string",
      "currency": "string",
      "precision": 2,
      "rate_format": "string",
      "taxes_included": true,
      "tax_deduction_ratio": 0,
      "net_deduction_ratio": 0,
      "transaction_type": {
        "id": 0,
        "name": "string",
        "associated_payment_cards": [
          "string"
        ]
      },
      "tax_nexus": {
        "id": 0,
        "code": "string",
        "currency": "string",
        "taxes": [
          {
            "index": 0,
            "code": "string",
            "name": "string",
            "currency": "string",
            "rate_type": "string",
            "is_implicit": true,
            "rates": [
              {
                "rate": 0,
                "is_default": true
              }
            ]
          }
        ],
        "jurisdiction": {
          "country": "string",
          "region": "string",
          "subregion": "string",
          "city": "string",
          "postal_code": "string"
        },
        "registration_mode": "string"
      },
      "total_amount": 0,
      "subtotal_amount": 0,
      "copy_from_id": 0,
      "taxes": [
        {
          "id": 0,
          "tax_index": 0,
          "tax_rate": 0,
          "tax_amount": 0,
          "tax_base": 0,
          "tax_code": "string",
          "tax_name": "string",
          "rate_type": "string"
        }
      ],
      "items": [
        {
          "id": 0,
          "description": "string",
          "qty": 0,
          "rate": 0,
          "rate_discounted": 0,
          "discount_explicit": 0,
          "discount_implicit": 0,
          "amount": 0,
          "payment_amount": 0,
          "currency": "string",
          "tax_deduction_ratio": 0,
          "net_deduction_ratio": 0,
          "item": {
            "id": 0,
            "code": "string",
            "name_org": "string",
            "name_leg": "string",
            "name": "string",
            "desc_org": "string",
            "desc_leg": "string",
            "desc": "string"
          },
          "unit": {
            "id": 0,
            "unece_code": "string",
            "name_org": "string",
            "name_leg": "string",
            "name": "string"
          },
          "paid_record": {
            "id": 0,
            "no": "string",
            "type": "string",
            "contact": {
              "id": 0,
              "business_name": "string"
            }
          },
          "taxes": [
            {
              "id": 0,
              "tax_rate": 0,
              "tax_amount": 0,
              "tax_base": 0,
              "tax_index": 0,
              "tax_code": "string",
              "tax_name": "string",
              "rate_type": "string"
            }
          ]
        }
      ],
      "rsn": "string"
    }
  ],
  "aggregations": [
    null
  ]
}

application/json

Schema

Schema

total int64nullable
from int64nullable
take int64nullable

entities

object[]

nullable

Array [

id int64nullable

uid uuidnullable

created_at date-timenullable

edited_at date-timenullable

is_locked boolean

no stringnullable

vendor_receipt_no stringnullable

vendor

object

id int64nullable

business_name stringnullable

display_name stringnullable

reg_no stringnullable

vat_no stringnullable

tax_no stringnullable

address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

email stringnullable

preferred_locale stringnullable

phone stringnullable

culture stringnullable

date_issued datenullable

description stringnullable

currency stringnullable

precision int32nullable

Default value: 2

rate_format stringnullable

taxes_included boolean

tax_deduction_ratio doublenullable

net_deduction_ratio doublenullable

transaction_type

object

id int32nullable

name stringnullable

associated_payment_cards string[]nullable

tax_nexus

object

id int32nullable

code stringnullable

currency stringnullable

taxes

object[]

nullable

Array [

index int64nullable

code stringnullable

name stringnullable

currency stringnullable

rate_type stringnullable

is_implicit boolean

rates

object[]

nullable

Array [

rate double

is_default boolean

]

]

jurisdiction

object

country stringnullable

region stringnullable

subregion stringnullable

city stringnullable

postal_code stringnullable

registration_mode stringnullable

total_amount doublenullable

subtotal_amount doublenullable

copy_from_id int64nullable

taxes

object[]

nullable

Array [

id int64nullable

tax_index int32nullable

tax_rate doublenullable

tax_amount doublenullable

tax_base doublenullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

items

object[]

nullable

Array [

id int64nullable

description stringnullable

qty double

rate doublenullable

rate_discounted doublenullable

discount_explicit doublenullable

discount_implicit doublenullable

amount doublenullable

payment_amount doublenullable

currency stringnullable

tax_deduction_ratio doublenullable

net_deduction_ratio doublenullable

item

object

id int64

code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

desc_org stringnullable

desc_leg stringnullable

desc stringnullable

unit

object

id int32nullable

unece_code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

paid_record

object

id int64nullable

no stringnullable

type stringnullable

contact

object

id int64nullable

business_name stringnullable

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_base doublenullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

]

rsn stringnullable

]

aggregations undefined[]nullable

Example (from schema)

{
  "total": 0,
  "from": 0,
  "take": 0,
  "entities": [
    {
      "id": 0,
      "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "2024-07-29T15:51:28.071Z",
      "edited_at": "2024-07-29T15:51:28.071Z",
      "is_locked": true,
      "no": "string",
      "vendor_receipt_no": "string",
      "vendor": {
        "id": 0,
        "business_name": "string",
        "display_name": "string",
        "reg_no": "string",
        "vat_no": "string",
        "tax_no": "string",
        "address": {
          "name": "string",
          "company": "string",
          "address1": "string",
          "address2": "string",
          "postal_code": "string",
          "city": "string",
          "region": "string",
          "country": "string"
        },
        "email": "string",
        "preferred_locale": "string",
        "phone": "string"
      },
      "culture": "string",
      "date_issued": "2024-07-29",
      "description": "string",
      "currency": "string",
      "precision": 2,
      "rate_format": "string",
      "taxes_included": true,
      "tax_deduction_ratio": 0,
      "net_deduction_ratio": 0,
      "transaction_type": {
        "id": 0,
        "name": "string",
        "associated_payment_cards": [
          "string"
        ]
      },
      "tax_nexus": {
        "id": 0,
        "code": "string",
        "currency": "string",
        "taxes": [
          {
            "index": 0,
            "code": "string",
            "name": "string",
            "currency": "string",
            "rate_type": "string",
            "is_implicit": true,
            "rates": [
              {
                "rate": 0,
                "is_default": true
              }
            ]
          }
        ],
        "jurisdiction": {
          "country": "string",
          "region": "string",
          "subregion": "string",
          "city": "string",
          "postal_code": "string"
        },
        "registration_mode": "string"
      },
      "total_amount": 0,
      "subtotal_amount": 0,
      "copy_from_id": 0,
      "taxes": [
        {
          "id": 0,
          "tax_index": 0,
          "tax_rate": 0,
          "tax_amount": 0,
          "tax_base": 0,
          "tax_code": "string",
          "tax_name": "string",
          "rate_type": "string"
        }
      ],
      "items": [
        {
          "id": 0,
          "description": "string",
          "qty": 0,
          "rate": 0,
          "rate_discounted": 0,
          "discount_explicit": 0,
          "discount_implicit": 0,
          "amount": 0,
          "payment_amount": 0,
          "currency": "string",
          "tax_deduction_ratio": 0,
          "net_deduction_ratio": 0,
          "item": {
            "id": 0,
            "code": "string",
            "name_org": "string",
            "name_leg": "string",
            "name": "string",
            "desc_org": "string",
            "desc_leg": "string",
            "desc": "string"
          },
          "unit": {
            "id": 0,
            "unece_code": "string",
            "name_org": "string",
            "name_leg": "string",
            "name": "string"
          },
          "paid_record": {
            "id": 0,
            "no": "string",
            "type": "string",
            "contact": {
              "id": 0,
              "business_name": "string"
            }
          },
          "taxes": [
            {
              "id": 0,
              "tax_rate": 0,
              "tax_amount": 0,
              "tax_base": 0,
              "tax_index": 0,
              "tax_code": "string",
              "tax_name": "string",
              "rate_type": "string"
            }
          ]
        }
      ],
      "rsn": "string"
    }
  ],
  "aggregations": [
    null
  ]
}

text/json

Schema

Schema

total int64nullable
from int64nullable
take int64nullable

entities

object[]

nullable

Array [

id int64nullable

uid uuidnullable

created_at date-timenullable

edited_at date-timenullable

is_locked boolean

no stringnullable

vendor_receipt_no stringnullable

vendor

object

id int64nullable

business_name stringnullable

display_name stringnullable

reg_no stringnullable

vat_no stringnullable

tax_no stringnullable

address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

email stringnullable

preferred_locale stringnullable

phone stringnullable

culture stringnullable

date_issued datenullable

description stringnullable

currency stringnullable

precision int32nullable

Default value: 2

rate_format stringnullable

taxes_included boolean

tax_deduction_ratio doublenullable

net_deduction_ratio doublenullable

transaction_type

object

id int32nullable

name stringnullable

associated_payment_cards string[]nullable

tax_nexus

object

id int32nullable

code stringnullable

currency stringnullable

taxes

object[]

nullable

Array [

index int64nullable

code stringnullable

name stringnullable

currency stringnullable

rate_type stringnullable

is_implicit boolean

rates

object[]

nullable

Array [

rate double

is_default boolean

]

]

jurisdiction

object

country stringnullable

region stringnullable

subregion stringnullable

city stringnullable

postal_code stringnullable

registration_mode stringnullable

total_amount doublenullable

subtotal_amount doublenullable

copy_from_id int64nullable

taxes

object[]

nullable

Array [

id int64nullable

tax_index int32nullable

tax_rate doublenullable

tax_amount doublenullable

tax_base doublenullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

items

object[]

nullable

Array [

id int64nullable

description stringnullable

qty double

rate doublenullable

rate_discounted doublenullable

discount_explicit doublenullable

discount_implicit doublenullable

amount doublenullable

payment_amount doublenullable

currency stringnullable

tax_deduction_ratio doublenullable

net_deduction_ratio doublenullable

item

object

id int64

code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

desc_org stringnullable

desc_leg stringnullable

desc stringnullable

unit

object

id int32nullable

unece_code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

paid_record

object

id int64nullable

no stringnullable

type stringnullable

contact

object

id int64nullable

business_name stringnullable

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_base doublenullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

]

rsn stringnullable

]

aggregations undefined[]nullable

Example (from schema)

{
  "total": 0,
  "from": 0,
  "take": 0,
  "entities": [
    {
      "id": 0,
      "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "2024-07-29T15:51:28.071Z",
      "edited_at": "2024-07-29T15:51:28.071Z",
      "is_locked": true,
      "no": "string",
      "vendor_receipt_no": "string",
      "vendor": {
        "id": 0,
        "business_name": "string",
        "display_name": "string",
        "reg_no": "string",
        "vat_no": "string",
        "tax_no": "string",
        "address": {
          "name": "string",
          "company": "string",
          "address1": "string",
          "address2": "string",
          "postal_code": "string",
          "city": "string",
          "region": "string",
          "country": "string"
        },
        "email": "string",
        "preferred_locale": "string",
        "phone": "string"
      },
      "culture": "string",
      "date_issued": "2024-07-29",
      "description": "string",
      "currency": "string",
      "precision": 2,
      "rate_format": "string",
      "taxes_included": true,
      "tax_deduction_ratio": 0,
      "net_deduction_ratio": 0,
      "transaction_type": {
        "id": 0,
        "name": "string",
        "associated_payment_cards": [
          "string"
        ]
      },
      "tax_nexus": {
        "id": 0,
        "code": "string",
        "currency": "string",
        "taxes": [
          {
            "index": 0,
            "code": "string",
            "name": "string",
            "currency": "string",
            "rate_type": "string",
            "is_implicit": true,
            "rates": [
              {
                "rate": 0,
                "is_default": true
              }
            ]
          }
        ],
        "jurisdiction": {
          "country": "string",
          "region": "string",
          "subregion": "string",
          "city": "string",
          "postal_code": "string"
        },
        "registration_mode": "string"
      },
      "total_amount": 0,
      "subtotal_amount": 0,
      "copy_from_id": 0,
      "taxes": [
        {
          "id": 0,
          "tax_index": 0,
          "tax_rate": 0,
          "tax_amount": 0,
          "tax_base": 0,
          "tax_code": "string",
          "tax_name": "string",
          "rate_type": "string"
        }
      ],
      "items": [
        {
          "id": 0,
          "description": "string",
          "qty": 0,
          "rate": 0,
          "rate_discounted": 0,
          "discount_explicit": 0,
          "discount_implicit": 0,
          "amount": 0,
          "payment_amount": 0,
          "currency": "string",
          "tax_deduction_ratio": 0,
          "net_deduction_ratio": 0,
          "item": {
            "id": 0,
            "code": "string",
            "name_org": "string",
            "name_leg": "string",
            "name": "string",
            "desc_org": "string",
            "desc_leg": "string",
            "desc": "string"
          },
          "unit": {
            "id": 0,
            "unece_code": "string",
            "name_org": "string",
            "name_leg": "string",
            "name": "string"
          },
          "paid_record": {
            "id": 0,
            "no": "string",
            "type": "string",
            "contact": {
              "id": 0,
              "business_name": "string"
            }
          },
          "taxes": [
            {
              "id": 0,
              "tax_rate": 0,
              "tax_amount": 0,
              "tax_base": 0,
              "tax_index": 0,
              "tax_code": "string",
              "tax_name": "string",
              "rate_type": "string"
            }
          ]
        }
      ],
      "rsn": "string"
    }
  ],
  "aggregations": [
    null
  ]
}

Loading...