Create Vendor Credit

curl --request POST \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-credits/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "<string>",
  "line_items": [
    {
      "amount": 2,
      "sales_taxes": [
        {}
      ],
      "expense_account_identifier": "<unknown>",
      "memo": "<string>",
      "metadata": {},
      "reference_number": "<string>",
      "tags": [
        {}
      ]
    }
  ],
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_external_id": "<string>",
  "source_bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "received_at": "2023-11-07T05:31:56Z",
  "allocations": [
    {
      "amount": 2,
      "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "tags": [
    {}
  ],
  "document": {
    "file": "<string>",
    "document_type": "vendor_credit",
    "upload_source": "<string>",
    "metadata": "<unknown>",
    "tags": "<unknown>"
  }
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "received_at": "2023-11-07T05:31:56Z",
  "vendor": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "display_name": "<string>"
  },
  "source_bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "line_items": [
    {
      "amount": 123,
      "expense_account_identifier": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "AccountId"
      },
      "tags": [
        "<string>"
      ],
      "memo": "<string>",
      "metadata": "<unknown>"
    }
  ],
  "allocations": [
    {
      "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bill_number": "<string>",
      "amount_cents": 123,
      "bill_outstanding_balance_cents": 123,
      "applied_at": "2023-11-07T05:31:56Z"
    }
  ],
  "tags": [
    {}
  ],
  "total_amount": 123,
  "applied_amount": 123,
  "document": {
    "url": "<string>",
    "expires_in": 123,
    "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "file_name": "<string>",
    "file_size": 123,
    "mime_type": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "currency": "EUR"
}

POST

platform

businesses

{business_id}

vendor-credits

Create Vendor Credit

curl --request POST \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-credits/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "<string>",
  "line_items": [
    {
      "amount": 2,
      "sales_taxes": [
        {}
      ],
      "expense_account_identifier": "<unknown>",
      "memo": "<string>",
      "metadata": {},
      "reference_number": "<string>",
      "tags": [
        {}
      ]
    }
  ],
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_external_id": "<string>",
  "source_bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "received_at": "2023-11-07T05:31:56Z",
  "allocations": [
    {
      "amount": 2,
      "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "tags": [
    {}
  ],
  "document": {
    "file": "<string>",
    "document_type": "vendor_credit",
    "upload_source": "<string>",
    "metadata": "<unknown>",
    "tags": "<unknown>"
  }
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "received_at": "2023-11-07T05:31:56Z",
  "vendor": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "display_name": "<string>"
  },
  "source_bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "line_items": [
    {
      "amount": 123,
      "expense_account_identifier": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "AccountId"
      },
      "tags": [
        "<string>"
      ],
      "memo": "<string>",
      "metadata": "<unknown>"
    }
  ],
  "allocations": [
    {
      "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bill_number": "<string>",
      "amount_cents": 123,
      "bill_outstanding_balance_cents": 123,
      "applied_at": "2023-11-07T05:31:56Z"
    }
  ],
  "tags": [
    {}
  ],
  "total_amount": 123,
  "applied_amount": 123,
  "document": {
    "url": "<string>",
    "expires_in": 123,
    "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "file_name": "<string>",
    "file_size": 123,
    "mime_type": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "currency": "EUR"
}

Authorizations

Authorization

string

header

required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

business_id

string

required

Body

Vendor credit creation serializer with line_items support.

Creates vendor credits with line_items for flexible account allocation.

external_id

string

required

External system identifier for this vendor credit

Minimum string length: 1

line_items

object[]

required

Array of line items for this vendor credit

Show child attributes

vendor_id

string<uuid>

Existing vendor ID to assign credit to

vendor_external_id

string

External vendor ID. Will create vendor if not found

source_bill_id

string<uuid> | null

Optional bill ID this credit note was created from (origin tracking, not allocation)

received_at

string<date-time>

When the credit was received (ISO 8601). Defaults to now if provided

allocations

object[]

Array of bill allocations for this credit

Show child attributes

Response

Vendor credit serializer for API responses.

string<uuid>

required

Unique vendor credit identifier

status

string

required

Credit status: draft, received, partially_applied, applied, void (computed from allocations)

received_at

string<date-time>

required

When the credit was received

vendor

object

required

Vendor who issued the credit (inline details)

Show child attributes

source_bill_id

string<uuid> | null

required

Bill ID this credit was created from (origin tracking, not allocation)

line_items

object[]

required

Array of credit line items

Show child attributes

allocations

object[]

required

Array of bill allocations

Show child attributes

Managing Businesses

Importing Business Activity

Financial Reports

Create Vendor Credit

Authorizations

Path Parameters

Body

Response