Create Invoice

ApiScope: payment.invoice.write
API Scope Level: DepartmentScope

Path Parameters

departmentUuid string required

application/json

Request Body required

amount number
description string
refundedAmount number
paidDate date-time
signatureFileName string
reminderDate date-time
reminderMileage int64
fileName string
paymentDeclines string
invoiceAttributes object
property name* string
dealerUuid string
orderUuid string
customerUuid string
dealerAssociateDepartmentUuid string
dealerAssociateUuid string
attachInvoice boolean

Responses

• 200

---

OK

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]
invoice object
id int64
guid string
invoiceStatus string
amount number
invoiceDate date-time
description string
refundedAmount number
paidDate date-time
fileName string
reminderMileage int64
reminderDate date-time
signatureFileName string
paymentDeclines string
invoiceAttributes object
property name* string
paymentDealer object
dealerUuid string
paymentDealerOrder object
orderNumber string
orderType string
departmentUuid string
dealerOrderUuid string
paymentCustomer object
customerUuid string
paymentUser object
id int64
dealerAssociateUUID string
userUUID string
dealerDepartmentUUID string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ],
  "invoice": {
    "id": 0,
    "guid": "string",
    "invoiceStatus": "string",
    "amount": 0,
    "invoiceDate": "2025-03-28T11:34:46.584Z",
    "description": "string",
    "refundedAmount": 0,
    "paidDate": "2025-03-28T11:34:46.584Z",
    "fileName": "string",
    "reminderMileage": 0,
    "reminderDate": "2025-03-28T11:34:46.584Z",
    "signatureFileName": "string",
    "paymentDeclines": "string",
    "invoiceAttributes": {},
    "paymentDealer": {
      "dealerUuid": "string"
    },
    "paymentDealerOrder": {
      "orderNumber": "string",
      "orderType": "string",
      "departmentUuid": "string",
      "dealerOrderUuid": "string"
    },
    "paymentCustomer": {
      "customerUuid": "string"
    },
    "paymentUser": {
      "id": 0,
      "dealerAssociateUUID": "string",
      "userUUID": "string",
      "dealerDepartmentUUID": "string"
    }
  }
}

POST /v4/departments/:departmentUuid/invoices

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/payment

Username

Password

departmentUuid — path required

Body required

{
  "amount": 0,
  "description": "string",
  "refundedAmount": 0,
  "paidDate": "2025-03-28T11:34:46.511Z",
  "signatureFileName": "string",
  "reminderDate": "2025-03-28T11:34:46.511Z",
  "reminderMileage": 0,
  "fileName": "string",
  "paymentDeclines": "string",
  "invoiceAttributes": {},
  "dealerUuid": "string",
  "orderUuid": "string",
  "customerUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "dealerAssociateUuid": "string",
  "attachInvoice": true
}

curl / cURL

curl -L -X POST '/payment/v4/departments/:departmentUuid/invoices' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "amount": 0,
  "description": "string",
  "refundedAmount": 0,
  "paidDate": "2025-03-28T11:34:46.511Z",
  "signatureFileName": "string",
  "reminderDate": "2025-03-28T11:34:46.511Z",
  "reminderMileage": 0,
  "fileName": "string",
  "paymentDeclines": "string",
  "invoiceAttributes": {},
  "dealerUuid": "string",
  "orderUuid": "string",
  "customerUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "dealerAssociateUuid": "string",
  "attachInvoice": true
}'

python / requests

curl -L -X POST '/payment/v4/departments/:departmentUuid/invoices' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "amount": 0,
  "description": "string",
  "refundedAmount": 0,
  "paidDate": "2025-03-28T11:34:46.511Z",
  "signatureFileName": "string",
  "reminderDate": "2025-03-28T11:34:46.511Z",
  "reminderMileage": 0,
  "fileName": "string",
  "paymentDeclines": "string",
  "invoiceAttributes": {},
  "dealerUuid": "string",
  "orderUuid": "string",
  "customerUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "dealerAssociateUuid": "string",
  "attachInvoice": true
}'

go / native

curl -L -X POST '/payment/v4/departments/:departmentUuid/invoices' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "amount": 0,
  "description": "string",
  "refundedAmount": 0,
  "paidDate": "2025-03-28T11:34:46.511Z",
  "signatureFileName": "string",
  "reminderDate": "2025-03-28T11:34:46.511Z",
  "reminderMileage": 0,
  "fileName": "string",
  "paymentDeclines": "string",
  "invoiceAttributes": {},
  "dealerUuid": "string",
  "orderUuid": "string",
  "customerUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "dealerAssociateUuid": "string",
  "attachInvoice": true
}'

nodejs / axios

curl -L -X POST '/payment/v4/departments/:departmentUuid/invoices' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "amount": 0,
  "description": "string",
  "refundedAmount": 0,
  "paidDate": "2025-03-28T11:34:46.511Z",
  "signatureFileName": "string",
  "reminderDate": "2025-03-28T11:34:46.511Z",
  "reminderMileage": 0,
  "fileName": "string",
  "paymentDeclines": "string",
  "invoiceAttributes": {},
  "dealerUuid": "string",
  "orderUuid": "string",
  "customerUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "dealerAssociateUuid": "string",
  "attachInvoice": true
}'

ruby / Net::HTTP

curl -L -X POST '/payment/v4/departments/:departmentUuid/invoices' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "amount": 0,
  "description": "string",
  "refundedAmount": 0,
  "paidDate": "2025-03-28T11:34:46.511Z",
  "signatureFileName": "string",
  "reminderDate": "2025-03-28T11:34:46.511Z",
  "reminderMileage": 0,
  "fileName": "string",
  "paymentDeclines": "string",
  "invoiceAttributes": {},
  "dealerUuid": "string",
  "orderUuid": "string",
  "customerUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "dealerAssociateUuid": "string",
  "attachInvoice": true
}'

csharp / RestSharp

curl -L -X POST '/payment/v4/departments/:departmentUuid/invoices' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "amount": 0,
  "description": "string",
  "refundedAmount": 0,
  "paidDate": "2025-03-28T11:34:46.511Z",
  "signatureFileName": "string",
  "reminderDate": "2025-03-28T11:34:46.511Z",
  "reminderMileage": 0,
  "fileName": "string",
  "paymentDeclines": "string",
  "invoiceAttributes": {},
  "dealerUuid": "string",
  "orderUuid": "string",
  "customerUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "dealerAssociateUuid": "string",
  "attachInvoice": true
}'

php / cURL

curl -L -X POST '/payment/v4/departments/:departmentUuid/invoices' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "amount": 0,
  "description": "string",
  "refundedAmount": 0,
  "paidDate": "2025-03-28T11:34:46.511Z",
  "signatureFileName": "string",
  "reminderDate": "2025-03-28T11:34:46.511Z",
  "reminderMileage": 0,
  "fileName": "string",
  "paymentDeclines": "string",
  "invoiceAttributes": {},
  "dealerUuid": "string",
  "orderUuid": "string",
  "customerUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "dealerAssociateUuid": "string",
  "attachInvoice": true
}'

java / OkHttp

curl -L -X POST '/payment/v4/departments/:departmentUuid/invoices' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "amount": 0,
  "description": "string",
  "refundedAmount": 0,
  "paidDate": "2025-03-28T11:34:46.511Z",
  "signatureFileName": "string",
  "reminderDate": "2025-03-28T11:34:46.511Z",
  "reminderMileage": 0,
  "fileName": "string",
  "paymentDeclines": "string",
  "invoiceAttributes": {},
  "dealerUuid": "string",
  "orderUuid": "string",
  "customerUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "dealerAssociateUuid": "string",
  "attachInvoice": true
}'

powershell / RestMethod

curl -L -X POST '/payment/v4/departments/:departmentUuid/invoices' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "amount": 0,
  "description": "string",
  "refundedAmount": 0,
  "paidDate": "2025-03-28T11:34:46.511Z",
  "signatureFileName": "string",
  "reminderDate": "2025-03-28T11:34:46.511Z",
  "reminderMileage": 0,
  "fileName": "string",
  "paymentDeclines": "string",
  "invoiceAttributes": {},
  "dealerUuid": "string",
  "orderUuid": "string",
  "customerUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "dealerAssociateUuid": "string",
  "attachInvoice": true
}'