Get Invoices
GetInvoices
This method returns information about a specific invoice.
Input
GetInvoicesRequest
| Field | R | Type | Description |
|---|---|---|---|
| InvoicesToRetrieve | * | Collection of GetInvoiceInformation | Describes the invoices to retrieve. |
Output
GetInvoicesResponse
| Field | R | Type | Description |
|---|---|---|---|
| Invoices | * | Collection of Invoice | The invoices that match the request. |
Structures
GetInvoiceInformation
| Field | R | Type | Description |
|---|---|---|---|
| InvoiceId | * | Long(10) | Reference to an Invoice. |
| ClientId | * | Long | ID that identifies a client in the Svea Payments system. |
Invoice
| Field | U | R | Type | Description |
|---|---|---|---|---|
| ClientId | * | * | Long(7) | ID that identifies a client in the Svea Payments system. |
| InvoiceId | - | * | Long(10) | Reference to an Invoice. |
| CreditedAmount | - | * | Decimal(18,2) | The total amount that is credited on this invoice. |
| UnmatchedCreditAmount | - | - | Decimal(18,2) | The amount credited on this invoice that does not match any invoice rows. |
| InvoiceDate | - | * | DateTime | Date when the invoice is created in the Svea Payments system. |
| DueDate | - | * | DateTime | Due date for the invoice; when Svea Payments requires the invoice to be paid. |
| EarliestPossibleNewDueDate | - | - | Nullable of DateTime | The earliest possible new due date that the invoice may be set to. If null, changing the invoice date is not possible. |
| LatestPossibleNewDueDate | - | - | Nullable of DateTime | The latest possible new due date that the invoice may be set to. If null, changing the invoice date is not possible. |
| PaidToClientDate | - | - | Nullable of DateTime | Date when Svea Payments paid (or will pay) the client for the invoice. |
| Amount | - | * | Decimal(15,2) | Invoice amount. |
| SveaOrderId | - | * | Long(10) | Unique ID for the created order. Used for any further order webservice requests. |
| SveaHasBought | - | * | Boolean | True if Svea Payments bought the invoice, otherwise false. |
| Currency | - | * | String | Currency of the country that the invoice was created for. |
| ClientOrderId | - | - | String(30) | Order number from the client’s ordersystem. |
| Status | - | * | (String) InvoicePaymentStatus | See InvoicePaymentStatus. |
| Type | - | * | InvoiceType | See InvoiceType. |
| CustomerReference | - | - | String(32) | |
| Reminder1Date | - | - | Nullable of DateTime | Date of the first reminder. |
| Reminder2Date | - | - | Nullable of DateTime | Date of the second reminder. |
| DeboCollectionDate | - | - | Nullable of DateTime | Date when the invoice went to debt collection. |
| CreditedDate | - | - | Nullable of DateTime | Date when the invoice was credited. |
| Notes | - | - | String(200) | Note on invoice from client to customer. |
| ClientReference | - | - | String(32) | |
| Customer | - | * | CustomerIdentity | Identity of the customer. |
| CustomerId | - | - | Nullable of Long | Customer ID created by Svea Payments system. |
| InvoiceRows | - | * | Array of NumberedOrderRow | See NumberedOrderRow. |
| CreditApproved | - | * | Boolean | True if credit was accepted, false otherwise. |
| IsPossibleToCancel | - | * | Boolean | Indicates if the invoice can be cancelled. |
CustomerIdentity
| Field | U | R | Type | Description |
|---|---|---|---|---|
| NationalIdNumber | * | - | String | Field for entering unique identifiers for customers in certain countries. (Example: Personnummer & organisationsnummer in Sweden). Will not be returned for Finnish clients. |
| - | - | String | A valid email address of the customer. | |
| PhoneNumber | - | - | String | Customer’s phone number. |
| IpAddress | - | - | String | Customer’s IP-address. |
| FullName | - | * | String | Full name of the customer. Either first name + family name or company name. |
| Street | - | * | String | Customer’s street address. |
| CoAddress | - | - | String | Customer co-address. |
| ZipCode | - | * | String | The complete zip code of the customer. |
| HouseNumber | - | - | String | House number (only applicable in certain countries). |
| Locality | - | * | String | Customer’s town of residence. |
| CountryCode | - | * | String (2) | A country code which defines where the customer is residing. |
| CustomerType | - | * | CustomerType | See CustomerType. |
| IndividualIdentity | - | - | IndividualIdentity | Only if the CustomerType is Individual. |
| CompanyIdentity | - | - | CompanyIdentity | Only if the CustomerType is Company. |
IndividualIdentity
| Field | R | Type | Description |
|---|---|---|---|
| FirstName | * | String | |
| LastName | * | String | |
| Initials | - | String | Only used in NL, “voorletters” |
| BirthDate | - | String | Date of birth in format YYYYMMDD. (Required for DE and NL) |
CompanyIdentity
| Field | R | Type | Description |
|---|---|---|---|
| CompanyIdentification | - | String | Not in use. |
| CompanyVatNumber | - | String | Company VAT number (Required for DE and NL). |