POST /invoices
Changed onCreates an individual invoice for a business.
Request
- Base URLhttps://api.railz.ai
- AuthHTTP bearer
Request body
Example request
{
"connection": {
"businessName": "Railz",
"serviceName": "quickbooks"
},
"data": {
"passThrough": {
"CustomField": [
{
"DefinitionId": "1",
"StringValue": "my custom value",
"Name": "Field One"
}
]
},
"invoiceNumber": "INV-10546",
"postedDate": "2021-03-29",
"dueDate": "2021-03-29",
"currency": "CAD",
"currencyRate": 1.13,
"memo": "Example invoice memo.",
"customerRef": "132",
"lines": [
{
"description": "Services rendered.",
"quantity": 3,
"inventoryRef": "240",
"locationRef": "3",
"accountRef": "145",
"discountPercentage": 30,
"subTotal": 301.5,
"totalAmount": 322,
"unitAmount": 100.5,
"taxAmount": 20.5,
"taxRef": "24"
}
]
}
}Response
Example response
{
"pushCommunicationId": "60473b57f0cdd1683ca71f60",
"requestedOn": "2021-03-09T08:15:22.035Z",
"status": "pending",
"businessName": "Railz",
"serviceName": "quickbooks",
"data": {
"passThrough": {
"CustomField": [
{
"DefinitionId": "1",
"StringValue": "my custom value",
"Name": "Field One"
}
]
},
"invoiceNumber": "INV-10546",
"postedDate": "2021-03-29",
"dueDate": "2021-03-29",
"currency": "CAD",
"currencyRate": 1.13,
"memo": "Example invoice memo.",
"customerRef": "132",
"lines": [
{
"description": "Services rendered.",
"quantity": 3,
"inventoryRef": "240",
"locationRef": "3",
"accountRef": "145",
"discountPercentage": 30,
"subTotal": 301.5,
"totalAmount": 322,
"unitAmount": 100.5,
"taxAmount": 20.5,
"taxRef": "24"
}
]
}
}Changes
- info
api tag
Invoiceadded
- info
- breaking
the
/request property format changed fromdate-timetodate - breaking
the
/request property format changed fromdate-timetodate - breaking
the response property
///////became optional for the status - breaking
the response property
///////became optional for the status - breaking
the
response's property format changed fromuuidto no format for status - warning
added the new
byodenum value to theresponse property for the response status - warning
added the new
dynamics365Financeenum value to theresponse property for the response status - warning
added the new
dynamicsBusinessCentralenum value to theresponse property for the response status - warning
added the new
freshbooksenum value to theresponse property for the response status - warning
added the new
myobenum value to theresponse property for the response status - warning
added the new
oracleNetsuiteenum value to theresponse property for the response status - warning
added the new
quickbooksenum value to theresponse property for the response status - warning
added the new
quickbooksDesktopenum value to theresponse property for the response status - warning
added the new
sageBusinessCloudenum value to theresponse property for the response status - warning
added the new
sageIntacctenum value to theresponse property for the response status - warning
added the new
waveenum value to theresponse property for the response status - warning
added the new
xeroenum value to theresponse property for the response status - warning
added the new
zohoBooksenum value to theresponse property for the response status - info
added the new optional request property
/ - info
the request property
///became optional - info
the request property
///became optional - info
request property
///deprecated - info
request property
///deprecated - info
added the new
byodenum value to the request property/ - info
added the new
dynamics365Financeenum value to the request property/ - info
added the new
zohoBooksenum value to the request property/ - info
the
/request property format was generalized fromuuidto no format - info
added the optional property
/////to the response with the status - info
response property
data/allOf[PushInvoice]/lines/items/subTotaldeprecated - info
response property
data/allOf[PushInvoice]/lines/items/totalAmountdeprecated
- breaking