Create one or many BatchPayments for invoices

PUT {{baseUrl}}/BatchPayments?summarizeErrors=false

Request Params

KeyDatatypeRequiredDescription
summarizeErrorsbooleanIf false return 200 OK and mix of successfully created objects and any with validation errors

Request Body

{"BatchPayments"=>[{"Account"=>{"Code"=>"<string>", "Name"=>"<string>", "AccountID"=>"<uuid>", "Type"=>"<string>", "BankAccountNumber"=>"<string>", "Status"=>"<string>", "Description"=>"<string>", "BankAccountType"=>"<string>", "CurrencyCode"=>"<string>", "TaxType"=>"<string>", "EnablePaymentsToAccount"=>"<boolean>", "ShowInExpenseClaims"=>"<boolean>", "ReportingCode"=>"<string>", "AddToWatchlist"=>"<boolean>", "ValidationErrors"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}]}, "Reference"=>"<string>", "Particulars"=>"<string>", "Code"=>"<string>", "Details"=>"<string>", "Narrative"=>"<string>", "DateString"=>"<string>", "Date"=>"<string>", "Amount"=>"<double>", "Payments"=>[{"Invoice"=>{"Type"=>"<string>", "Contact"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "LineItems"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "Date"=>"<string>", "DueDate"=>"<string>", "LineAmountTypes"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "InvoiceNumber"=>"<string>", "Reference"=>"<string>", "BrandingThemeID"=>"<uuid>", "Url"=>"<string>", "CurrencyCode"=>"<string>", "CurrencyRate"=>"<double>", "Status"=>"<string>", "SentToContact"=>"<boolean>", "ExpectedPaymentDate"=>"<string>", "PlannedPaymentDate"=>"<string>", "InvoiceID"=>"<uuid>", "RepeatingInvoiceID"=>"<uuid>", "Attachments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "HasErrors"=>"false", "StatusAttributeString"=>"<string>", "ValidationErrors"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "Warnings"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "CreditNote"=>{"Type"=>"<string>", "Contact"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Date"=>"<string>", "DueDate"=>"<string>", "Status"=>"<string>", "LineAmountTypes"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "LineItems"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "SubTotal"=>"<double>", "TotalTax"=>"<double>", "Total"=>"<double>", "CurrencyCode"=>"<string>", "FullyPaidOnDate"=>"<string>", "CreditNoteID"=>"<uuid>", "CreditNoteNumber"=>"<string>", "Reference"=>"<string>", "CurrencyRate"=>"<double>", "RemainingCredit"=>"<double>", "Allocations"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "AppliedAmount"=>"<double>", "Payments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "BrandingThemeID"=>"<uuid>", "StatusAttributeString"=>"<string>", "HasAttachments"=>"false", "HasErrors"=>"false", "ValidationErrors"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "Prepayment"=>{"Type"=>"<string>", "Contact"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Date"=>"<string>", "Status"=>"<string>", "LineAmountTypes"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "LineItems"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "SubTotal"=>"<double>", "TotalTax"=>"<double>", "Total"=>"<double>", "CurrencyCode"=>"<string>", "PrepaymentID"=>"<uuid>", "CurrencyRate"=>"<double>", "RemainingCredit"=>"<double>", "Allocations"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "AppliedAmount"=>"<double>", "Attachments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "Overpayment"=>{"Type"=>"<string>", "Contact"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Date"=>"<string>", "Status"=>"<string>", "LineAmountTypes"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "LineItems"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "SubTotal"=>"<double>", "TotalTax"=>"<double>", "Total"=>"<double>", "CurrencyCode"=>"<string>", "OverpaymentID"=>"<uuid>", "CurrencyRate"=>"<double>", "RemainingCredit"=>"<double>", "Allocations"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "AppliedAmount"=>"<double>", "Payments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "Attachments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "InvoiceNumber"=>"<string>", "CreditNoteNumber"=>"<string>", "Account"=>{"Code"=>"<string>", "Name"=>"<string>", "AccountID"=>"<uuid>", "Type"=>"<string>", "BankAccountNumber"=>"<string>", "Status"=>"<string>", "Description"=>"<string>", "BankAccountType"=>"<string>", "CurrencyCode"=>"<string>", "TaxType"=>"<string>", "EnablePaymentsToAccount"=>"<boolean>", "ShowInExpenseClaims"=>"<boolean>", "ReportingCode"=>"<string>", "AddToWatchlist"=>"<boolean>", "ValidationErrors"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}]}, "Code"=>"<string>", "Date"=>"<string>", "CurrencyRate"=>"<double>", "Amount"=>"<double>", "Reference"=>"<string>", "IsReconciled"=>"<boolean>", "Status"=>"<string>", "PaymentID"=>"<uuid>", "BankAccountNumber"=>"<string>", "Particulars"=>"<string>", "Details"=>"<string>", "HasAccount"=>"false", "HasValidationErrors"=>"false", "StatusAttributeString"=>"<string>", "ValidationErrors"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}]}, {"Invoice"=>{"Type"=>"<string>", "Contact"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "LineItems"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "Date"=>"<string>", "DueDate"=>"<string>", "LineAmountTypes"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "InvoiceNumber"=>"<string>", "Reference"=>"<string>", "BrandingThemeID"=>"<uuid>", "Url"=>"<string>", "CurrencyCode"=>"<string>", "CurrencyRate"=>"<double>", "Status"=>"<string>", "SentToContact"=>"<boolean>", "ExpectedPaymentDate"=>"<string>", "PlannedPaymentDate"=>"<string>", "InvoiceID"=>"<uuid>", "RepeatingInvoiceID"=>"<uuid>", "Attachments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "HasErrors"=>"false", "StatusAttributeString"=>"<string>", "ValidationErrors"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "Warnings"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "CreditNote"=>{"Type"=>"<string>", "Contact"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Date"=>"<string>", "DueDate"=>"<string>", "Status"=>"<string>", "LineAmountTypes"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "LineItems"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "SubTotal"=>"<double>", "TotalTax"=>"<double>", "Total"=>"<double>", "CurrencyCode"=>"<string>", "FullyPaidOnDate"=>"<string>", "CreditNoteID"=>"<uuid>", "CreditNoteNumber"=>"<string>", "Reference"=>"<string>", "CurrencyRate"=>"<double>", "RemainingCredit"=>"<double>", "Allocations"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "AppliedAmount"=>"<double>", "Payments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "BrandingThemeID"=>"<uuid>", "StatusAttributeString"=>"<string>", "HasAttachments"=>"false", "HasErrors"=>"false", "ValidationErrors"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "Prepayment"=>{"Type"=>"<string>", "Contact"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Date"=>"<string>", "Status"=>"<string>", "LineAmountTypes"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "LineItems"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "SubTotal"=>"<double>", "TotalTax"=>"<double>", "Total"=>"<double>", "CurrencyCode"=>"<string>", "PrepaymentID"=>"<uuid>", "CurrencyRate"=>"<double>", "RemainingCredit"=>"<double>", "Allocations"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "AppliedAmount"=>"<double>", "Attachments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "Overpayment"=>{"Type"=>"<string>", "Contact"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Date"=>"<string>", "Status"=>"<string>", "LineAmountTypes"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "LineItems"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "SubTotal"=>"<double>", "TotalTax"=>"<double>", "Total"=>"<double>", "CurrencyCode"=>"<string>", "OverpaymentID"=>"<uuid>", "CurrencyRate"=>"<double>", "RemainingCredit"=>"<double>", "Allocations"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "AppliedAmount"=>"<double>", "Payments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "Attachments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "InvoiceNumber"=>"<string>", "CreditNoteNumber"=>"<string>", "Account"=>{"Code"=>"<string>", "Name"=>"<string>", "AccountID"=>"<uuid>", "Type"=>"<string>", "BankAccountNumber"=>"<string>", "Status"=>"<string>", "Description"=>"<string>", "BankAccountType"=>"<string>", "CurrencyCode"=>"<string>", "TaxType"=>"<string>", "EnablePaymentsToAccount"=>"<boolean>", "ShowInExpenseClaims"=>"<boolean>", "ReportingCode"=>"<string>", "AddToWatchlist"=>"<boolean>", "ValidationErrors"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}]}, "Code"=>"<string>", "Date"=>"<string>", "CurrencyRate"=>"<double>", "Amount"=>"<double>", "Reference"=>"<string>", "IsReconciled"=>"<boolean>", "Status"=>"<string>", "PaymentID"=>"<uuid>", "BankAccountNumber"=>"<string>", "Particulars"=>"<string>", "Details"=>"<string>", "HasAccount"=>"false", "HasValidationErrors"=>"false", "StatusAttributeString"=>"<string>", "ValidationErrors"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}]}]}, {"Account"=>{"Code"=>"<string>", "Name"=>"<string>", "AccountID"=>"<uuid>", "Type"=>"<string>", "BankAccountNumber"=>"<string>", "Status"=>"<string>", "Description"=>"<string>", "BankAccountType"=>"<string>", "CurrencyCode"=>"<string>", "TaxType"=>"<string>", "EnablePaymentsToAccount"=>"<boolean>", "ShowInExpenseClaims"=>"<boolean>", "ReportingCode"=>"<string>", "AddToWatchlist"=>"<boolean>", "ValidationErrors"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}]}, "Reference"=>"<string>", "Particulars"=>"<string>", "Code"=>"<string>", "Details"=>"<string>", "Narrative"=>"<string>", "DateString"=>"<string>", "Date"=>"<string>", "Amount"=>"<double>", "Payments"=>[{"Invoice"=>{"Type"=>"<string>", "Contact"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "LineItems"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "Date"=>"<string>", "DueDate"=>"<string>", "LineAmountTypes"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "InvoiceNumber"=>"<string>", "Reference"=>"<string>", "BrandingThemeID"=>"<uuid>", "Url"=>"<string>", "CurrencyCode"=>"<string>", "CurrencyRate"=>"<double>", "Status"=>"<string>", "SentToContact"=>"<boolean>", "ExpectedPaymentDate"=>"<string>", "PlannedPaymentDate"=>"<string>", "InvoiceID"=>"<uuid>", "RepeatingInvoiceID"=>"<uuid>", "Attachments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "HasErrors"=>"false", "StatusAttributeString"=>"<string>", "ValidationErrors"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "Warnings"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "CreditNote"=>{"Type"=>"<string>", "Contact"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Date"=>"<string>", "DueDate"=>"<string>", "Status"=>"<string>", "LineAmountTypes"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "LineItems"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "SubTotal"=>"<double>", "TotalTax"=>"<double>", "Total"=>"<double>", "CurrencyCode"=>"<string>", "FullyPaidOnDate"=>"<string>", "CreditNoteID"=>"<uuid>", "CreditNoteNumber"=>"<string>", "Reference"=>"<string>", "CurrencyRate"=>"<double>", "RemainingCredit"=>"<double>", "Allocations"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "AppliedAmount"=>"<double>", "Payments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "BrandingThemeID"=>"<uuid>", "StatusAttributeString"=>"<string>", "HasAttachments"=>"false", "HasErrors"=>"false", "ValidationErrors"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "Prepayment"=>{"Type"=>"<string>", "Contact"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Date"=>"<string>", "Status"=>"<string>", "LineAmountTypes"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "LineItems"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "SubTotal"=>"<double>", "TotalTax"=>"<double>", "Total"=>"<double>", "CurrencyCode"=>"<string>", "PrepaymentID"=>"<uuid>", "CurrencyRate"=>"<double>", "RemainingCredit"=>"<double>", "Allocations"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "AppliedAmount"=>"<double>", "Attachments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "Overpayment"=>{"Type"=>"<string>", "Contact"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Date"=>"<string>", "Status"=>"<string>", "LineAmountTypes"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "LineItems"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "SubTotal"=>"<double>", "TotalTax"=>"<double>", "Total"=>"<double>", "CurrencyCode"=>"<string>", "OverpaymentID"=>"<uuid>", "CurrencyRate"=>"<double>", "RemainingCredit"=>"<double>", "Allocations"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "AppliedAmount"=>"<double>", "Payments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "Attachments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "InvoiceNumber"=>"<string>", "CreditNoteNumber"=>"<string>", "Account"=>{"Code"=>"<string>", "Name"=>"<string>", "AccountID"=>"<uuid>", "Type"=>"<string>", "BankAccountNumber"=>"<string>", "Status"=>"<string>", "Description"=>"<string>", "BankAccountType"=>"<string>", "CurrencyCode"=>"<string>", "TaxType"=>"<string>", "EnablePaymentsToAccount"=>"<boolean>", "ShowInExpenseClaims"=>"<boolean>", "ReportingCode"=>"<string>", "AddToWatchlist"=>"<boolean>", "ValidationErrors"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}]}, "Code"=>"<string>", "Date"=>"<string>", "CurrencyRate"=>"<double>", "Amount"=>"<double>", "Reference"=>"<string>", "IsReconciled"=>"<boolean>", "Status"=>"<string>", "PaymentID"=>"<uuid>", "BankAccountNumber"=>"<string>", "Particulars"=>"<string>", "Details"=>"<string>", "HasAccount"=>"false", "HasValidationErrors"=>"false", "StatusAttributeString"=>"<string>", "ValidationErrors"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}]}, {"Invoice"=>{"Type"=>"<string>", "Contact"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "LineItems"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "Date"=>"<string>", "DueDate"=>"<string>", "LineAmountTypes"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "InvoiceNumber"=>"<string>", "Reference"=>"<string>", "BrandingThemeID"=>"<uuid>", "Url"=>"<string>", "CurrencyCode"=>"<string>", "CurrencyRate"=>"<double>", "Status"=>"<string>", "SentToContact"=>"<boolean>", "ExpectedPaymentDate"=>"<string>", "PlannedPaymentDate"=>"<string>", "InvoiceID"=>"<uuid>", "RepeatingInvoiceID"=>"<uuid>", "Attachments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "HasErrors"=>"false", "StatusAttributeString"=>"<string>", "ValidationErrors"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "Warnings"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "CreditNote"=>{"Type"=>"<string>", "Contact"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Date"=>"<string>", "DueDate"=>"<string>", "Status"=>"<string>", "LineAmountTypes"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "LineItems"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "SubTotal"=>"<double>", "TotalTax"=>"<double>", "Total"=>"<double>", "CurrencyCode"=>"<string>", "FullyPaidOnDate"=>"<string>", "CreditNoteID"=>"<uuid>", "CreditNoteNumber"=>"<string>", "Reference"=>"<string>", "CurrencyRate"=>"<double>", "RemainingCredit"=>"<double>", "Allocations"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "AppliedAmount"=>"<double>", "Payments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "BrandingThemeID"=>"<uuid>", "StatusAttributeString"=>"<string>", "HasAttachments"=>"false", "HasErrors"=>"false", "ValidationErrors"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "Prepayment"=>{"Type"=>"<string>", "Contact"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Date"=>"<string>", "Status"=>"<string>", "LineAmountTypes"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "LineItems"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "SubTotal"=>"<double>", "TotalTax"=>"<double>", "Total"=>"<double>", "CurrencyCode"=>"<string>", "PrepaymentID"=>"<uuid>", "CurrencyRate"=>"<double>", "RemainingCredit"=>"<double>", "Allocations"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "AppliedAmount"=>"<double>", "Attachments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "Overpayment"=>{"Type"=>"<string>", "Contact"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Date"=>"<string>", "Status"=>"<string>", "LineAmountTypes"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "LineItems"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "SubTotal"=>"<double>", "TotalTax"=>"<double>", "Total"=>"<double>", "CurrencyCode"=>"<string>", "OverpaymentID"=>"<uuid>", "CurrencyRate"=>"<double>", "RemainingCredit"=>"<double>", "Allocations"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "AppliedAmount"=>"<double>", "Payments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "Attachments"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "InvoiceNumber"=>"<string>", "CreditNoteNumber"=>"<string>", "Account"=>{"Code"=>"<string>", "Name"=>"<string>", "AccountID"=>"<uuid>", "Type"=>"<string>", "BankAccountNumber"=>"<string>", "Status"=>"<string>", "Description"=>"<string>", "BankAccountType"=>"<string>", "CurrencyCode"=>"<string>", "TaxType"=>"<string>", "EnablePaymentsToAccount"=>"<boolean>", "ShowInExpenseClaims"=>"<boolean>", "ReportingCode"=>"<string>", "AddToWatchlist"=>"<boolean>", "ValidationErrors"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}]}, "Code"=>"<string>", "Date"=>"<string>", "CurrencyRate"=>"<double>", "Amount"=>"<double>", "Reference"=>"<string>", "IsReconciled"=>"<boolean>", "Status"=>"<string>", "PaymentID"=>"<uuid>", "BankAccountNumber"=>"<string>", "Particulars"=>"<string>", "Details"=>"<string>", "HasAccount"=>"false", "HasValidationErrors"=>"false", "StatusAttributeString"=>"<string>", "ValidationErrors"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}]}]}]}

HEADERS

KeyDatatypeRequiredDescription
xero-tenant-idstring(Required) Xero identifier for Tenant
Content-Typestring

RESPONSES

status: OK

{&quot;Id&quot;:&quot;424745ed-6356-46ad-87d4-3585f9062fb4&quot;,&quot;Status&quot;:&quot;OK&quot;,&quot;ProviderName&quot;:&quot;Xero API Partner&quot;,&quot;DateTimeUTC&quot;:&quot;/Date(1550865988111)/&quot;,&quot;BatchPayments&quot;:[{&quot;Account&quot;:{&quot;AccountID&quot;:&quot;5ec2f302-cd60-4f8b-a915-9229dd45e6fa&quot;},&quot;Reference&quot;:&quot;Foobar123&quot;,&quot;BatchPaymentID&quot;:&quot;d318c343-208e-49fe-b04a-45642349bcf1&quot;,&quot;DateString&quot;:&quot;2019-02-22T00:00:00&quot;,&quot;Date&quot;:&quot;/Date(1550793600000+0000)/&quot;,&quot;Payments&quot;:[{&quot;Invoice&quot;:{&quot;InvoiceID&quot;:&quot;3323652c-155e-433b-8a73-4dde7cfbf410&quot;,&quot;Payments&quot;:[],&quot;CreditNotes&quot;:[],&quot;Prepayments&quot;:[],&quot;Overpayments&quot;:[],&quot;HasErrors&quot;:false,&quot;IsDiscounted&quot;:false,&quot;LineItems&quot;:[]},&quot;PaymentID&quot;:&quot;c05098fa-ae3c-4f00-80ec-0a9df07dedff&quot;,&quot;Amount&quot;:1.0},{&quot;Invoice&quot;:{&quot;InvoiceID&quot;:&quot;e4abafb4-1f5b-4d9f-80b3-9a7b815bc302&quot;,&quot;Payments&quot;:[],&quot;CreditNotes&quot;:[],&quot;Prepayments&quot;:[],&quot;Overpayments&quot;:[],&quot;HasErrors&quot;:false,&quot;IsDiscounted&quot;:false,&quot;LineItems&quot;:[]},&quot;PaymentID&quot;:&quot;96409489-2f7d-4804-9a6d-6b939b0e038a&quot;,&quot;Amount&quot;:1.0},{&quot;Invoice&quot;:{&quot;InvoiceID&quot;:&quot;e6039672-b161-40cd-b07b-a0178e7186ad&quot;,&quot;Payments&quot;:[],&quot;CreditNotes&quot;:[],&quot;Prepayments&quot;:[],&quot;Overpayments&quot;:[],&quot;HasErrors&quot;:false,&quot;IsDiscounted&quot;:false,&quot;LineItems&quot;:[]},&quot;PaymentID&quot;:&quot;d2796067-bf71-4f06-b386-81f1454fa866&quot;,&quot;Amount&quot;:1.0}],&quot;Type&quot;:&quot;RECBATCH&quot;,&quot;Status&quot;:&quot;AUTHORISED&quot;,&quot;TotalAmount&quot;:3.0,&quot;UpdatedDateUTC&quot;:&quot;/Date(1550865987783+0000)/&quot;,&quot;IsReconciled&quot;:false}]}