Outbound messages (1.0)

Download OpenAPI specification:Download

Public api that deals with transactions

Transaction

API Connector - post approved invoices / credit notes to customer-specified endpoint

Authorizations:

XCompleatApiKey

Request Body schema: application/json

object (transaction)

Responses

Request samples

Payload

Content type

application/json

{"Transaction": {"Id": "b8432eeb-0d38-4b6c-95d7-c75f19c97279",
"Company": {"Id": "42210aac-b6d3-4eeb-bcec-583dab5c0ddf",
"Name": "Example Company"
},
"Owner": {"Id": "4a7f92c7-a1ce-41eb-ae21-64c71843921a",
"Name": "John Doe"
},
"Type": "INV",
"References": {"Identifier": "INV00000123",
"PurchaseOrder": "125-87",
"Supplier": "AMZ/1234/AA.3"
},
"Dates": {"Created": "2018-08-07T12:30:33",
"Invoice": "2018-09-01T00:00:00",
"PaymentDue": "2018-10-01T00:00:00",
"Delivery": "2018-10-01T00:00:00"
},
"Title": "Replacement toaster",
"Supplier": {"Name": "Amazon Europe",
"Code": "AMZ001"
},
"Net": {"Base": {"Display": "£20.00",
"Value": 20
},
"Local": {"Display": "€21.00",
"Value": 21
}
},
"Vat": {"Base": {"Display": "£4.00",
"Value": 4
},
"Local": {"Display": "€5.00",
"Value": 5
}
},
"Gross": {"Base": {"Display": "£24.00",
"Value": 24
},
"Local": {"Display": "€26.00",
"Value": 26
}
},
"Status": "SAV",
"CurrencyCode": {"Base": "GBP",
"Local": "EUR"
},
"Comment": "Delivered via Amazon Prime",
"Layout": {"Code": "SLINV",
"Name": "Standard low-value invoices layout"
},
"BankDetails": {"BankStatus": "BKDETNM",
"BankSortCode": "10-20-30",
"BankAccountNumber": "12345678",
"BankSortCodeFinance": "11-22-33",
"BankAccountNumberFinance": "98765432"
},
"MatchingStatusDetail": {"References": [{"Id": "42210aac-b6d3-4eeb-bcec-583dab5c0ddf",
"Reference": "ORD0000123",
"TxType": "ORD"
}
],
"MatchStatus": "MCH",
"Description": "This is fully matched to ORD00000123"
},
"LastUpdateGuid": "76f81046-1905-419e-a70f-bd39945b0b34",
"Analysis": [{"Id": "42210aac-b6d3-4eeb-bcec-583dab5c0ddf",
"TypeId": "3BC9E1E0-259D-4A54-9E43-2FB7E697F131",
"Name": "Account Code",
"Value": {"Code": "7700",
"Name": "Kitchen supplies"
}
},
{"Id": "42210aac-b6d3-4eeb-bcec-583dab5c0ddf",
"TypeId": "03757B33-3883-482C-A5D8-477543546EE6",
"Name": "Currency Code",
"Value": {"Code": "EUR",
"Name": "Euros"
}
},
{"Id": "42210aac-b6d3-4eeb-bcec-583dab5c0ddf",
"TypeId": "49382aac-b6d3-4eeb-bcec-583dab5c0ddf",
"Name": "Location",
"Value": {"Code": "NOR1",
"Name": "Norwich Office"
}
}
],
"DeliverySite": [{"Id": "42210aac-b6d3-4eeb-bcec-583dab5c0ddf"
}
],
"Lines": [{"Id": "42210aac-b6d3-4eeb-bcec-583dab5c0ddf",
"Number": 1,
"Code": "B00049382",
"Description": "Toaster",
"Quantity": 1,
"ReceiptReference": "Receipt10001",
"UnitCost": {"Base": {"Display": "£20.00",
"Value": 20
},
"Local": {"Display": "€21.00",
"Value": 21
}
},
"Net": {"Base": {"Display": "£20.00",
"Value": 20
},
"Local": {"Display": "€21.00",
"Value": 21
}
},
"Vat": {"Base": {"Display": "£4.00",
"Value": 4
},
"Local": {"Display": "€5.00",
"Value": 5
}
},
"Gross": {"Base": {"Display": "£24.00",
"Value": 24
},
"Local": {"Display": "€26.00",
"Value": 26
}
},
"Analysis": [{"Id": "42210aac-b6d3-4eeb-bcec-583dab5c0ddf",
"TypeId": " AE0F8C02-7E53-402C-8E17-189B33E702D8",
"Name": "Tax Code",
"Value": {"Code": "T1",
"Name": "Standard 20%"
}
}
]
}
],
"Attachments": [{"Id": "42210aac-b6d3-4eeb-bcec-583dab5c0ddf",
"MimeType": "application/pdf",
"Type": "PO"
},
{"Id": "4a7f92c7-a1ce-41eb-ae21-64c71843921a ",
"MimeType": "text/html",
"Type": "OTHER"
}
],
"Notes": [{"Id": "42210aac-b6d3-4eeb-bcec-583dab5c0ddf",
"Text": "Need a replacement by end of the week please.",
"Owner": {"Id": "4a7f92c7-a1ce-41eb-ae21-64c71843921a",
"Name": "John Doe"
},
"DateCreated": "2018-08-09T09:40:45"
},
{"Id": "57210aac-b6d3-4eeb-bcec-583dab5c0ddf",
"Text": "Revised net value.",
"Owner": {"Id": "4a7f92c7-a1ce-41eb-ae21-64c71843921a",
"Name": "John Doe"
},
"DateCreated": "2018-08-10T12:00:40"
}
]
}
}

Response samples

Content type

application/json

{"JournalNumber": "AV5938539"
}