Skip to main content
GET
/
public
/
v1
/
vendor-credits
/
{record_number}
Get VendorCredit record
curl --request GET \
  --url https://api.dualentry.com/public/v1/vendor-credits/{record_number}/ \
  --header 'X-API-KEY: <api-key>'
{
  "company_vat_number": "<string>",
  "counterparty_vat_number": "<string>",
  "company_gst_number": "<string>",
  "counterparty_gst_number": "<string>",
  "company_pst_number": "<string>",
  "counterparty_pst_number": "<string>",
  "supply_date": "2023-12-25",
  "tax": {
    "data": {}
  },
  "transaction_ids": [
    123
  ],
  "internal_id": 123,
  "number": 123,
  "date": "2023-12-25",
  "transaction_date": "2023-12-25",
  "company_id": 123,
  "company_name": "<string>",
  "company_currency": "<string>",
  "vendor_id": 123,
  "vendor_name": "<string>",
  "currency_iso_4217_code": "<string>",
  "exchange_rate": "<string>",
  "memo": "<string>",
  "items": [
    {
      "id": 123,
      "position": 123,
      "rate": "<string>",
      "quantity": "<string>",
      "memo": "<string>",
      "net_amount": "<string>",
      "tax_amount": "<string>",
      "gross_amount": "<string>",
      "amount": "<string>",
      "tax": {
        "code": "<string>",
        "rate": "<string>",
        "amount": "<string>",
        "is_taxable": true,
        "tax_exempt_amount": "<string>",
        "vat_rate_id": 123,
        "gst_tax_rate_id": 123,
        "tax_components": [
          {
            "rate": "<string>",
            "amount": "<string>",
            "position": 123,
            "region": "<string>"
          }
        ],
        "amount_with_tax": "<string>",
        "rate_name": "<string>",
        "rate_type": "<string>",
        "tax_treatment": "<string>"
      },
      "item_id": 123,
      "classifications": [],
      "item_type": "<string>",
      "hsn_sac_code": "<string>",
      "item_name": "<string>"
    }
  ],
  "expenses": [
    {
      "id": 123,
      "quantity": "<string>",
      "rate": "<string>",
      "position": 123,
      "expense_description": "<string>",
      "net_amount": "<string>",
      "tax_amount": "<string>",
      "gross_amount": "<string>",
      "amount": "<string>",
      "tax": {
        "code": "<string>",
        "rate": "<string>",
        "amount": "<string>",
        "is_taxable": true,
        "tax_exempt_amount": "<string>",
        "vat_rate_id": 123,
        "gst_tax_rate_id": 123,
        "tax_components": [
          {
            "rate": "<string>",
            "amount": "<string>",
            "position": 123,
            "region": "<string>"
          }
        ],
        "amount_with_tax": "<string>",
        "rate_name": "<string>",
        "rate_type": "<string>",
        "tax_treatment": "<string>"
      },
      "account_number": 123,
      "customer_id": 123,
      "vendor_id": 123,
      "classifications": [],
      "account_name": "<string>",
      "customer_name": "<string>",
      "vendor_name": "<string>"
    }
  ],
  "amount": "<string>",
  "used_amount": "<string>",
  "remaining_amount": "<string>",
  "custom_fields": [],
  "attachments": [],
  "place_of_supply": "<string>",
  "tax_registration_numbers": {
    "company": [
      {
        "type": "<string>",
        "number": "<string>",
        "region": "<string>"
      }
    ],
    "counterparty": [
      {
        "type": "<string>",
        "number": "<string>",
        "region": "<string>"
      }
    ]
  },
  "classifications": [],
  "created_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "updated_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "bill_number": 123,
  "direct_expense_number": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.dualentry.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
record_number
integer
required

The number attribute of the record.

Query Parameters

​
search
string | null
​
company_id
integer[] | null
​
number
integer[] | null
​
vendor_id
integer[] | null
​
start_date
string<date> | null
​
end_date
string<date> | null
​
transaction_currency
enum<string> | null
Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLF,
CLP,
CNY,
COP,
CRC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ERN,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLL,
SOS,
SRD,
STN,
SVC,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VES,
VND,
VUV,
WST,
XAF,
XAG,
XAU,
XCD,
XDR,
XOF,
XPD,
XPF,
XPT,
YER,
ZAR,
ZMW,
ZWL
​
record_status
enum<string>[] | null
Available options:
draft,
posted,
archived
​
bill_number
integer[] | null

Response

OK

Output schema for Vendor Credit records.

​
company_vat_number
string | null
required
​
counterparty_vat_number
string | null
required
​
company_gst_number
string | null
required
​
counterparty_gst_number
string | null
required
​
company_pst_number
string | null
required
​
counterparty_pst_number
string | null
required
​
supply_date
string<date> | null
required
​
tax
RecordTaxContextOut · object
required

Base for record-level tax context; regime discriminates data.

Mirrors TaxResultV2Out (core.taxes.api.taxes)

​
transaction_ids
integer[]
required
​
internal_id
integer
required
​
number
integer
required
​
date
string<date>
required

Posting date (GL date) - the date when the transaction is recorded in the general ledger

​
transaction_date
string<date>
required

Transaction date (inception date) - the date when the transaction actually occurred

​
company_id
integer
required
​
company_name
string
required
​
company_currency
string
required
​
vendor_id
integer
required
​
vendor_name
string
required
​
currency_iso_4217_code
string | null
required
​
exchange_rate
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,16}0*$
​
memo
string
required
​
items
PublicVendorCreditItemOut · object[]
required
​
expenses
PublicVendorCreditExpenseOut · object[]
required
​
amount
string
required

Total transaction amount

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
​
used_amount
string
required

Amount that was already applied to Bills through Vendor Refunds or Vendor Prepayment Applications

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
​
remaining_amount
string
required

Amount that can be applied to Bills through Vendor Refunds or Vendor Prepayment Applications

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
​
record_status
enum<string>
required
Available options:
draft,
posted,
archived
​
custom_fields
CustomFieldValuePairOutputSchema · object[]
​
attachments
PublicAttachmentSchemaOut · object[]
​
place_of_supply
string | null
Maximum string length: 2
​
tax_registration_numbers
TaxRegistrationNumbersSnapshot · object
​
classifications
PublicRecordClassificationsSchemaOut · object[]
​
created_by
AuditActorSchemaOut · object

Schema for audit actor information.

​
updated_by
AuditActorSchemaOut · object

Schema for audit actor information.

​
bill_number
integer | null
​
direct_expense_number
integer | null
Last modified on May 28, 2026