117 lines
3.4 KiB
YAML
117 lines
3.4 KiB
YAML
RecurringInvoiceRequest:
|
|
required:
|
|
- client_id
|
|
- date
|
|
- due_date
|
|
- frequency_id
|
|
properties:
|
|
client_id:
|
|
description: 'The hashed ID of the client'
|
|
type: string
|
|
example: 'D2J234DFA'
|
|
date:
|
|
description: 'Recurring invoice date'
|
|
type: string
|
|
format: date
|
|
example: '2024-01-01'
|
|
due_date:
|
|
description: 'Due date for the recurring invoice'
|
|
type: string
|
|
format: date
|
|
example: '2024-01-31'
|
|
frequency_id:
|
|
description: 'Frequency ID for recurring invoice'
|
|
type: string
|
|
example: '1'
|
|
remaining_cycles:
|
|
description: 'Number of remaining cycles'
|
|
type: string
|
|
example: '5'
|
|
private_notes:
|
|
description: 'Private notes for the recurring invoice'
|
|
type: string
|
|
example: 'Internal notes about this recurring invoice'
|
|
public_notes:
|
|
description: 'Public notes for the recurring invoice'
|
|
type: string
|
|
example: 'Thank you for your business!'
|
|
custom_value1:
|
|
description: 'Custom field value 1'
|
|
type: string
|
|
example: 'Custom value 1'
|
|
custom_value2:
|
|
description: 'Custom field value 2'
|
|
type: string
|
|
example: 'Custom value 2'
|
|
custom_value3:
|
|
description: 'Custom field value 3'
|
|
type: string
|
|
example: 'Custom value 3'
|
|
custom_value4:
|
|
description: 'Custom field value 4'
|
|
type: string
|
|
example: 'Custom value 4'
|
|
line_items:
|
|
type: array
|
|
description: 'Array of line items for the recurring invoice'
|
|
items:
|
|
type: object
|
|
properties:
|
|
quantity:
|
|
type: number
|
|
example: 1
|
|
cost:
|
|
type: number
|
|
example: 14.00
|
|
product_key:
|
|
type: string
|
|
example: 'sku_4_u'
|
|
notes:
|
|
type: string
|
|
example: 'The actual product description'
|
|
discount:
|
|
type: number
|
|
example: 0
|
|
is_amount_discount:
|
|
type: boolean
|
|
example: true
|
|
tax_name1:
|
|
type: string
|
|
example: ''
|
|
tax_rate1:
|
|
type: number
|
|
example: 0
|
|
tax_name2:
|
|
type: string
|
|
example: ''
|
|
tax_rate2:
|
|
type: number
|
|
example: 0
|
|
tax_name3:
|
|
type: string
|
|
example: ''
|
|
tax_rate3:
|
|
type: number
|
|
example: 0
|
|
sort_id:
|
|
type: string
|
|
example: '0'
|
|
custom_value1:
|
|
type: string
|
|
example: 'https://picsum.photos/200'
|
|
custom_value2:
|
|
type: string
|
|
example: '94'
|
|
custom_value3:
|
|
type: string
|
|
example: 'Alias vel eveniet.'
|
|
custom_value4:
|
|
type: string
|
|
example: 'Iusto aut quis qui.'
|
|
type_id:
|
|
type: string
|
|
example: '1'
|
|
tax_id:
|
|
type: string
|
|
example: '1'
|
|
type: object |