Invoices

Request and Post invoices

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/erp/fs/invoice

Version: v1

Schemes:

Summary

Path Operation Description
/blanket POST
/multi POST
/simple POST
/vitg POST
/{batch_id} GET

Paths

POST /blanket

Tags: invoice

Insert invoices into peoplesoft

The blanket invoice to create.

total_invoice_amt: number
origin: string
invoice_count: number
invoices: object[]
object
po_id: string
invoice_id: string
invoice_date: string
"2018-07-06"                                                                                                                        
distributions: object[]
object
account: string
class: string
distribution_amt: number
operating_unit: string
pymnt_message: string
200 OK

success

validation_response: string[]
string
"All invoices passed the first inspection."                                                                                                                
successful_invoices: string[]
string
"invoice_id"                                                                                                                
unsuccessful_invoices: string[]
string
"invoice_id and reason why it failed"                                                                                                                
403 Forbidden

no authorization

validation_response: string[]
string
"User is not authorized for this origin"                                                                                                                
successful_invoices: string[]
string
unsuccessful_invoices: string[]
string

POST /multi

Tags: invoice

Insert invoices into peoplesoft

create invoices using multi format

total_invoice_amt: number
origin: string
invoice_count: number
invoices: object[]
object
pmnt_terms_cd: string
pymnt_comments: string
location: string
invoice_amt: number
sales_tax: number
due_date: string
"2018-07-06"                                                                                                                        
pymnt_addr_num: number
lines: object[]
object
1099_state_code: string
line_amt: number
distributions: object[]
object
account: string
class: string
distribution_amt: number
operating_unit: string
invoice_id: string
invoice_date: string
"2018-07-06"                                                                                                                        
vendor_id: string
reference: string
200 OK

success

validation_response: string[]
string
"All invoices passed the first inspection."                                                                                                                
successful_invoices: string[]
string
"invoice_id"                                                                                                                
unsuccessful_invoices: string[]
string
"invoice_id and reason why it failed"                                                                                                                
403 Forbidden

no authorization

validation_response: string[]
string
"User is not authorized for this origin"                                                                                                                
successful_invoices: string[]
string
unsuccessful_invoices: string[]
string

POST /simple

Tags: invoice

Insert invoices into peoplesoft

application/json

create invoices using simple format

total_invoice_amt: number
origin: string
invoice_count: number
invoices: object[]
object
addr_num: string
invoice_amt: number
sales_tax: number
pymnt_terms_cd: string
class: string
invoice_date: string
"2018-07-06"                                                                                                                        
vendor_id: string
remit_location: string
reference: string
pymnt_comments: string
due_date: string
"2018-07-06"                                                                                                                        
account: string
invoice_id: string
operating_unit: string

application/json

200 OK

success

validation_response: string[]
string
"All invoices passed the first inspection."                                                                                                                
successful_invoices: string[]
string
"invoice_id"                                                                                                                
unsuccessful_invoices: string[]
string
"invoice_id and reason why it failed"                                                                                                                
403 Forbidden

no authorization

validation_response: string[]
string
"User is not authorized for this origin"                                                                                                                
successful_invoices: string[]
string
unsuccessful_invoices: string[]
string

POST /vitg

Tags: invoice

Insert invoices into peoplesoft

create invoices using vitg format

total_invoice_amt: number
origin: string
invoice_count: number
invoices: object[]
object
sua_id: string
pymnt_comments: string
trans_id: string
trans_date: string
"2018-07-12"                                                                                                                        
location: string
invoice_amt: number
req_id: string
freight_amt: number
lines: object[]
object
uom_po: string
line_amt: number
quantity: number
unit_price: number
distributions: object[]
object
account: string
class: string
distribution_amt: number
operating_unit: string
1099_code: string
invoice_id: string
invoice_date: string
"2018-07-12"                                                                                                                        
vendor_id: string
200 OK

success

validation_response: string[]
string
"All invoices passed the first inspection."                                                                                                                
successful_invoices: string[]
string
"invoice_id"                                                                                                                
unsuccessful_invoices: string[]
string
"invoice_id and reason why it failed"                                                                                                                
403 Forbidden

no authorization

validation_response: string[]
string
"User is not authorized for this origin"                                                                                                                
successful_invoices: string[]
string
unsuccessful_invoices: string[]
string

GET /{batch_id}

batch_id path string
200 OK

success

validation_response: string[]
string
"Processing is now complete"                                                                                                                
unresolvable_invoices: string[]
string
non_processed_invoices: string[]
string
processed_invoices: string[]
string
"invoice_id - 00364698_5, voucher_id - 01408712"                                                                                                                
resolvable_invoices: string[]
string
Service Path: 
/domains/erp/fs/invoice
Domain or University API: 
/domains/erp/fs/invoice

Community

 

Don't see your question listed here? Ask!