Invoice Detail

The details of the invoice. Includes invoice number, date, payment terms, and audit metadata.

Schema Information

Type:object

Properties

reference

Type: string

Pattern: ^[\S\s]*$

Min length: 0

Max length: 120

The reference data. Includes a Purchase Order (PO) number.

currency_coderequired

Type: string

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

note

Type: string

Pattern: ^[\S\s]*$

Min length: 0

Max length: 4000

A note to the invoice recipient. Also appears on the invoice notification email.

terms_and_conditions

Type: string

Pattern: ^[\S\s]*$

Min length: 0

Max length: 4000

The general terms of the invoice. Can include return or cancellation policy and other terms and conditions.

memo

Type: string

Pattern: ^[\S\s]*$

Min length: 0

Max length: 500

A private bookkeeping memo for the user.

attachments

Type: array

An array of PayPal IDs for the files that are attached to an invoice.

Array Items

items

Type: object

The file reference. Can be a file in PayPal MediaServ, PayPal DMS, or other custom store.

id

Type: string

Min length: 1

Max length: 255

The ID of the referenced file.

reference_url

Type: string

Format: uri

Min length: 1

Max length: 2000

The reference URL for the file.

content_type

Type: string

The Internet Assigned Numbers Authority (IANA) media type of the file.

create_time

Type: string

Format: ppaas_date_time_v3

Pattern:

^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$

Min length: 20

Max length: 64

The date and time when the file was created, in Internet date and time format.

size

Type: string

Pattern: ^[0-9]+$

The size of the file, in bytes.

invoice_number

Type: string

Max length: 25

The invoice number. Default is the number that is auto-incremented number from the last number.

invoice_date

Type: string

Format: ppaas_date_notime_v2

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$

Min length: 10

Max length: 10

The invoice date as specificed by the sender, in Internet date and time format. Only UTC is supported in response. For example, yyyy-MM-ddTz.

payment_term

Type: object

The payment due date for the invoice. Value is either but not both term_type or due_date.

term_type

Type: string

Enum: "DUE_ON_RECEIPT", "DUE_ON_DATE_SPECIFIED", "NET_10", "NET_15", "NET_30", "NET_45", "NET_60", "NET_90", "NO_DUE_DATE"

Pattern: ^[\S\s]*$

Min length: 0

Max length: 255

The payment term. Payment can be due upon receipt, a specified date, or in a set number of days.

due_date

Type: string

Format: ppaas_date_notime_v2

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$

Min length: 10

Max length: 10

The date when the invoice payment is due, in Internet date and time format. For example, yyyy-MM-ddTz.

metadata

Type: object

The audit metadata. Captures all invoicing actions on create, send, update, and cancel.

create_time

Type: string

Format: ppaas_date_time_v3

Pattern:

^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$

Min length: 20

Max length: 64

The date and time when the resource was created, in Internet date and time format.

created_by

Type: string

Pattern: ^[\S\s]*$

Min length: 0

Max length: 2147483647

The email address of the account that created the resource.

last_update_time

Type: string

Format: ppaas_date_time_v3

Pattern:

^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$

Min length: 20

Max length: 64

The date and time when the resource was last edited, in Internet date and time format.

last_updated_by

Type: string

Pattern: ^[\S\s]*$

Min length: 0

Max length: 2147483647

The email address of the account that last edited the resource.

cancel_time

Type: string

Format: ppaas_date_time_v3

Pattern:

^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$

Min length: 20

Max length: 64

The date and time when the resource was canceled, in Internet date and time format.

cancelled_by

Type: string

The actor who canceled the resource.

first_sent_time

Type: string

Format: ppaas_date_time_v3

Pattern:

^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$

Min length: 20

Max length: 64

The date and time when the resource was first sent, in Internet date and time format.

last_sent_time

Type: string

Format: ppaas_date_time_v3

Pattern:

^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$

Min length: 20

Max length: 64

The date and time when the resource was last sent, in Internet date and time format.

last_sent_by

Type: string

The email address of the account that last sent the resource.

created_by_flow

Type: string

Enum: "MULTIPLE_RECIPIENTS_GROUP", "BATCH", "REGULAR_SINGLE"

Pattern: ^[\s\S]*$

Min length: 0

Max length: 255

The flow variation that created this invoice.

recipient_view_url

Type: string

Format: uri

The URL for the invoice payer view hosted on paypal.com.

invoicer_view_url

Type: string

Format: uri

The URL for the invoice merchant view hosted on paypal.com.

Properties

reference

Type: string

Pattern: ^[\S\s]*$

Min length: 0

Max length: 120

The reference data. Includes a Purchase Order (PO) number.

currency_coderequired

Type: string

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

note

Type: string

Pattern: ^[\S\s]*$

Min length: 0

Max length: 4000

A note to the invoice recipient. Also appears on the invoice notification email.

terms_and_conditions

Type: string

Pattern: ^[\S\s]*$

Min length: 0

Max length: 4000

The general terms of the invoice. Can include return or cancellation policy and other terms and conditions.

memo

Type: string

Pattern: ^[\S\s]*$

Min length: 0

Max length: 500

A private bookkeeping memo for the user.

attachments

Type: array

An array of PayPal IDs for the files that are attached to an invoice.

Array Items

items

Type: object

The file reference. Can be a file in PayPal MediaServ, PayPal DMS, or other custom store.

id

Type: string

Min length: 1

Max length: 255

The ID of the referenced file.

reference_url

Type: string

Format: uri

Min length: 1

Max length: 2000

The reference URL for the file.

content_type

Type: string

The Internet Assigned Numbers Authority (IANA) media type of the file.

create_time

Type: string

Format: ppaas_date_time_v3

Pattern:

^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$

Min length: 20

Max length: 64

The date and time when the file was created, in Internet date and time format.

size

Type: string

Pattern: ^[0-9]+$

The size of the file, in bytes.

invoice_number

Type: string

Max length: 25

The invoice number. Default is the number that is auto-incremented number from the last number.

invoice_date

Type: string

Format: ppaas_date_notime_v2

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$

Min length: 10

Max length: 10

The invoice date as specificed by the sender, in Internet date and time format. Only UTC is supported in response. For example, yyyy-MM-ddTz.

payment_term

Type: object

The payment due date for the invoice. Value is either but not both term_type or due_date.

term_type

Type: string

Enum: "DUE_ON_RECEIPT", "DUE_ON_DATE_SPECIFIED", "NET_10", "NET_15", "NET_30", "NET_45", "NET_60", "NET_90", "NO_DUE_DATE"

Pattern: ^[\S\s]*$

Min length: 0

Max length: 255

The payment term. Payment can be due upon receipt, a specified date, or in a set number of days.

due_date

Type: string

Format: ppaas_date_notime_v2

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$

Min length: 10

Max length: 10

The date when the invoice payment is due, in Internet date and time format. For example, yyyy-MM-ddTz.

metadata

Type: object

The audit metadata. Captures all invoicing actions on create, send, update, and cancel.

create_time

Type: string

Format: ppaas_date_time_v3

Pattern:

^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$

Min length: 20

Max length: 64

The date and time when the resource was created, in Internet date and time format.

created_by

Type: string

Pattern: ^[\S\s]*$

Min length: 0

Max length: 2147483647

The email address of the account that created the resource.

last_update_time

Type: string

Format: ppaas_date_time_v3

Pattern:

^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$

Min length: 20

Max length: 64

The date and time when the resource was last edited, in Internet date and time format.

last_updated_by

Type: string

Pattern: ^[\S\s]*$

Min length: 0

Max length: 2147483647

The email address of the account that last edited the resource.

cancel_time

Type: string

Format: ppaas_date_time_v3

Pattern:

^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$

Min length: 20

Max length: 64

The date and time when the resource was canceled, in Internet date and time format.

cancelled_by

Type: string

The actor who canceled the resource.

first_sent_time

Type: string

Format: ppaas_date_time_v3

Pattern:

^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$

Min length: 20

Max length: 64

The date and time when the resource was first sent, in Internet date and time format.

last_sent_time

Type: string

Format: ppaas_date_time_v3

Pattern:

^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$

Min length: 20

Max length: 64

The date and time when the resource was last sent, in Internet date and time format.

last_sent_by

Type: string

The email address of the account that last sent the resource.

created_by_flow

Type: string

Enum: "MULTIPLE_RECIPIENTS_GROUP", "BATCH", "REGULAR_SINGLE"

Pattern: ^[\s\S]*$

Min length: 0

Max length: 255

The flow variation that created this invoice.

recipient_view_url

Type: string

Format: uri

The URL for the invoice payer view hosted on paypal.com.

invoicer_view_url

Type: string

Format: uri

The URL for the invoice merchant view hosted on paypal.com.

Invoice Detail

Schema Information

Properties

On this page

If you accept cookies, we'll use them to improve and customise your experience and enable our partners to show you personalised PayPal ads when you visit other sites. Manage cookies and learn more

Invoice Detail

Schema Information

Properties