Faktura/Saldobesked Gränssnittsdokumentation. Version 5.1

Transkript

1 Version 5.1

2 Datum: Sida 2 av 20 Revisionshistorik Version Datum Kommentarer Lagt till info om att tjänsten är behörighetsskyddad Nya response-värden returneras vid sökning av faktura, pallsaldo och debiteringsbesked. Gäller punkt 3.2, 4.2 och Länkar och exempelanrop uppdaterade Uppdaterad med ny funktionalitet för visning och utsökning av pallsaldo. Punkt 5 och punkt Uppdaterat dokumentationen med tillägg av nya obligatoriska variabler vid utsökning av debiteringsbesked Detta är första gången denna dokumentation skrivs varför någon tidigare revisionshistorik ej finns.

3 Datum: Sida 3 av 20 INNEHÅLLSFÖRTECKNING REVISIONSHISTORIK FAKTURA/SALDOBESKED GENERELLA VARIABLER Request Response System MEDDELANDESÖKNING AV FAKTURA Request Response MEDDELANDESÖKNING AV DEBITERINGSBESKED Request Response MEDDELANDESÖKNING AV PALLSALDOBESKED Request Response MEDDELANDEHÄMTNING AV PDF-FAKTURA Request Response MEDDELANDEHÄMTNING AV PDF-DEBITERINGSBESKED Request Response MEDDELANDEHÄMTNING AV PDF-PALLSALDOBESKED Request Response... 20

4 Datum: Sida 4 av 20 1 är en tjänst som kräver behörighet. Ansökan görs via formuläret: Tjänsten ger externa kunder möjlighet att koppla sig till Schenkers system och alltid erhålla uppdaterad och korrekt information. Gränssnittet stöder sex olika metoder: Sökning av faktura, sökning av debiteringsbesked, sökning av pallsaldo, hämtning av faktura i pdf format, hämtning av debiteringsbesked i pdf-format och hämtning av pallsaldo i pdf-format. Tjänsten kan anropas med hjälp av httprequest via HQF (Http Query at, textformat) och kan returneras på två sätt: i XML eller textformat. Exempel på anrop respektive svar finns i dokumentet. Figur 1 Flödesskiss över tjänstens anrop För mer övergripande information om hur Schenkers e-tjänster är uppbyggda och anropas rekommenderas läsning i vårt separata introduktionsdokument. URL att anropa:

5 Datum: Sida 5 av 20 2 Generella variabler De generella variablerna är till för att administrera kommunikationen och är gemensamma för all kommunikation. De generella variablerna är: request, response samt system. Variablerna data_list är en vektor av information med själva meddelandet som är specifikt per metod. Rubriken O i tabellerna står för obligatoriskt fält. 2.1 Request Innehåller information till tjänsten. Frågan kan göras på sex sätt och värdet på service.method avgör vad som returneras. Lägg till prefixet request. till variablerna. service.action O String WDR Värde select service.method O String WDR Värde search_invoice, search_debit, search_pallet_balance, pdf_invoice, pdf_debit och pdf_pallet_balance user.password O String WDR Användarens lösen user.login_name O String WDR Användarnamn Admin.e_mail String WDR Användarens epost-adress format.mime O String WDR Värde text/xml och text/plain önskat returformat 2.2 Response Innehåller information från tjänsten. Hittas efter prefixet response. vid HQF. service.name O String WDR Namn på tjänsten service.version O String WDR Versionsnummer (1.0) data_list_count O Int WDR Antal i data_list 2.3 System Innehåller felkod från systemet. error.id = 0 betyder OK. Hittas efter prefixet system.. Innehåller även statistikvariabler till systemet. Placeras efter prefixet system.. error.id O Int WDR Felkod error.id = 0 betyder OK error.message String WDR Felmeddelande

6 Datum: Sida 6 av 20 statistics.remote.country_code O String WDR Landskod för klient, ex. se eller us statistics.remote.send_data_format O String WDR Klientens sätt att skicka sin Request, xml eller hqf (Http Query at) statistics.remote.access_type O String WDR Klientens anropstyp, A (webbläsare) statistics.remote.application_name O String WDR Klientens sida/modul som anropar statistics.user.return_mime_format O String WDR Klientens önskade svarsformat, text/plain, text/html eller text/xml statistics.user.organization_id O String WDR Klientens momsregistreringsnummer statistics.user.language_code O String WDR Språkkod för klient, ex. sv_se

7 Datum: Sida 7 av 20 3 Meddelandesökning av faktura service.method = search_invoice Faktura kan sökas på tre olika sätt: fakturanummer (reference_type=iv) sändningsnummer (reference_type=sm) datumintervall (reference_type=date). Om reference_type = iv eller sm används variabeln reference_number för att ange fakturanummer eller sändningsnummer. Om reference_type = date används variablerna start_date och end_date för att ange periodens start och slutdatum. 3.1 Request Information som skickas till tjänsten tillsammans med request-variablerna. Lägg till prefixet data_list.0. till variablerna. reference_type O String RFF Värde iv, sm och date iv = Fakturanummer (commercial_invoice_number) sm = Sändningsnummer (shipment_reference_number) date = Datumintervall reference_number O String RFF See Reference type Obligatorisk om reference_type = iv,eller sm start_date O String DTM end_date O String DTM Periodens startdatum Obligatorisk om reference_type = date = Date/time/period format code, code 4 = CCYYMMDD, example: Periodens slutdatum Obligatorisk om reference_type = date = Date/time/period format code, code 4 = CCYYMMDD, example: Exempel på sökning efter faktura via fakturanummer. Byt ut följande mot aktuella värden: <Kundens_momsregistreringsnummer> <Användar_ID>

8 Datum: Sida 8 av 20 <Användar_lösenord> <e_postadress> <Fakturanummer> tem.statistics.remote.send_data_format=hqf&system.statistics.remote.access_type=a&system.sta tistics.remote.application_name=test&system.statistics.user.organization_id=<kundens_momsre gistreringsnummer>&system.statistics.user.language_code=sv&system.statistics.user.return_mim e_format=xml&request.format.mime=text/xml&request.user.login_name=<användar_id>&request.user.password=<användar_lösenord>&request.admin.e_mail=<e_postadress>&request.service. action=select&request.service.method=search_invoice&data_list.0.reference_type=iv&data_list.0. reference_number=<fakturanummer> Exempel på sökning efter faktura via sändningsnummer. Byt ut följande mot aktuella värden: <Kundens_momsregistreringsnummer> <Användar_ID> <Användar_lösenord> <e_postadress> <Sändningsnummer> tem.statistics.remote.send_data_format=hqf&system.statistics.remote.access_type=a&system.sta tistics.remote.application_name=test&system.statistics.user.organization_id=<kundens_momsre gistreringsnummer>&system.statistics.user.language_code=sv&system.statistics.user.return_mim e_format=xml&request.format.mime=text/xml&request.user.login_name=<användar_id>&request.user.password=<användar_lösenord>&request.admin.e_mail=<e_postadress>&request.service. action=select&request.service.method=search_invoice&data_list.0.reference_type=sm&data_list. 0.reference_number=<Sändningsnummer> Exempel på sökning efter faktura vid datumintervall. Byt ut följande mot aktuella värden: <Kundens_momsregistreringsnummer> <Användar_ID> <Användar_lösenord> <e_postadress> <Kundnummer> tem.statistics.remote.send_data_format=hqf&system.statistics.remote.access_type=a&system.sta tistics.remote.application_name=test&system.statistics.user.organization_id=<kundens_momsre gistreringsnummer>&system.statistics.user.language_code=sv&system.statistics.user.return_mim e_format=xml&request.format.mime=text/xml&request.user.login_name=<användar_id>&request.user.password=<användar_lösenord>&request.admin.e_mail=<e_postadress>&request.service.

9 Datum: Sida 9 av 20 action=select&request.service.method=search_invoice&data_list.0.reference_type=date&data_list.0.start_date= &data_list.0.end_date= &data_list.0.customer_number=<Kundnummer> 3.2 Response Information som returneras från tjänsten tillsammans med response-variablerna. Lägg till prefixet data_list.n. till variablerna, där n är ett index som startar på 0. invoice_total_monetary_amount String MOA commercial_invoice_number String RFF DE IV DE 1154 invoice_date Date DTM customer_number String NAD DE 3039 office_number String NAD DE 3039 office_name String NAD DE 3036 Fakturabelopp Fakturanummer Datum när fakturan är utfärdad Kundnummer Kontorsnummer Kontorsnamn invoice_product_number String RFF Produktnummer 10=DKS 11=Adena Picko 13=DKS 16=DKS 30=Gods 32=Pall 33=Coldsped 34=Företagsbil 36=Parcel 39=Tankdata 40=Consulting 42=Logistics 900=Pallkreditering Exempel på svar: <?xml version="1.0" encoding="iso "?>

10 Datum: Sida 10 av 20 - <xml> - <response> <data_list_count>1</data_list_count> - <service> <name>invoicedoc</name> <version>1.0</version> </service> </response> - <system> - <error> <message>your request was successfully processed.</message> <id>0</id> </error> </system> - <data_list> - <data index="0"> <commercial_invoice_number> </commercial_invoice_number> <invoice_total_monetary_amount>800.00</invoice_total_monetary_amount> <office_number>356</office_number> <customer_number> </customer_number> <office_name>linköping</office_name> <invoice_date> </invoice_date> <invoice_product_number>30</invoice_product_number> </data> </data_list> </xml>

11 Datum: Sida 11 av 20 4 Meddelandesökning av debiteringsbesked service.method = search_debit Debiteringsbesked kan sökas på två sätt: datumintervall (reference_type=date) fakturanummer (reference_type=iv). Om reference_type = iv används variabeln reference_number för att ange fakturanummer. Om reference_type = date används variablerna start_date och end_date för att ange periodens start och slutdatum. 4.1 Request Information som skickas till tjänsten tillsammans med request-variablerna. Lägg till prefixet data_list.0. till variablerna. reference_type O String RFF Värde iv och date iv = Fakturanummer (commercial_invoice_number) date = Datumintervall reference_number O String RFF See Reference type Obligatorisk om reference_type = iv start_date O String DTM end_date O String DTM Periodens startdatum = Date/time/period format code, code 4 = CCYYMMDD, example: Periodens slutdatum = Date/time/period format code, code 4 = CCYYMMDD, example: Exempel på sökning efter debiteringsbesked via datumintervall. Byt ut följande mot aktuella värden: <Kundens_momsregistreringsnummer> <Användar_ID> <Användar_lösenord> <e_postadress> <Kundnummer>

12 Datum: Sida 12 av 20 tem.statistics.remote.send_data_format=hqf&system.statistics.remote.access_type=a&system.sta tistics.remote.application_name=test&system.statistics.user.organization_id=<kundens_momsre gistreringsnummer>&system.statistics.user.language_code=sv&system.statistics.user.return_mim e_format=xml&request.format.mime=text/xml&request.user.login_name=<användar_id>&request.user.password=<användar_lösenord>&request.admin.e_mail=<e_postadress>&request.service. action=select&request.service.method=search_debit&data_list.0.reference_type=date&data_list.0.start_date= &data_list.0.end_date= &data_list.0.customer_number=<Kundnummer> Exempel på sökning efter debiteringsbesked via fakturanummer. Byt ut följande mot aktuella värden: <Kundens_momsregistreringsnummer> <Användar_ID> <Användar_lösenord> <e_postadress> <Fakturanummer> tem.statistics.remote.send_data_format=hqf&system.statistics.remote.access_type=a&system.sta tistics.remote.application_name=test&system.statistics.user.organization_id=<kundens_momsre gistreringsnummer>&system.statistics.user.language_code=sv&system.statistics.user.return_mim e_format=xml&request.format.mime=text/xml&request.user.login_name=<användar_id>&request.user.password=<användar_lösenord>&request.admin.e_mail=<e_postadress>&request.service. action=select&request.service.method=search_debit&data_list.0.reference_type=iv&data_list.0.re ference_number=<fakturanummer> 4.2 Response Information som returneras från tjänsten tillsammans med response-variablerna. Lägg till prefixet data_list.n. till variablerna, där n är ett index som startar på 0. customer_number String NAD DE 3039 office_number String NAD DE 3039 office_name String NAD DE 3036 commercial_invoice_number String RFF 1153-IV DE 1154 accounting_period_start_date O String DTM Kundnummer Kontorsnummer Kontorsnamn Fakturanummer Konteringsperiodens startdatum

13 Datum: Sida 13 av 20 charge_amount String TCC DE 5004 debet_date Date DTM debit_id String = Date/time/period format code, code 4 = CCYYMMDD, example: Debiteringssumma Datum när debiteringsbeskedet är utfärdat. Exempel på svar: <?xml version="1.0" encoding="iso "?> - <xml> - <system> - <error> <id>0</id> <message>your request was successfully processed.</message> </error> </system> - <response> <data_list_count>2</data_list_count> - <service> <version>1.0</version> <name>invoicedoc</name> </service> </response> - <data_list> - <data index="1"> <charge_amount>883</charge_amount> <office_name>örebro</office_name> <debit_date>070322</debit_date> <office_number>422</office_number> <debit_id>428447</debit_id> <commercial_invoice_number> </commercial_invoice_number> <customer_number> </customer_number> <accounting_period_start_date>070323</accounting_period_start_date> </data> - <data index="0"> <charge_amount>495</charge_amount> <debit_id>427103</debit_id> <debit_date>070320</debit_date> <office_number>422</office_number> <accounting_period_start_date>070323</accounting_period_start_date> <customer_number> </customer_number> <commercial_invoice_number> </commercial_invoice_number> <office_name>örebro</office_name> </data> </data_list> </xml>

14 Datum: Sida 14 av 20 5 Meddelandesökning av pallsaldobesked service.method = search_pallet_balance Pallsaldobesked kan sökas på två sätt: datumintervall (reference_type=date) fakturanummer (reference_type=iv). Om reference_type = iv används variabeln reference_number för att ange fakturanummer. Om reference_type = date används variablerna start_date och end_date för att ange periodens start och slutdatum. 5.1 Request Information som skickas till tjänsten tillsammans med request-variablerna. Lägg till prefixet data_list.0. till variablerna. reference_type O String RFF Värde iv och date iv = Fakturanummer (commercial_invoice_number) date = Datumintervall reference_number O String RFF See Reference type Obligatorisk om reference_type = iv start_date O String DTM end_date O String DTM Periodens startdatums = Date/time/period format code, code 4 = CCYYMMDD, example: Periodens slutdatum = Date/time/period format code, code 4 = CCYYMMDD, example: Exempel på sökning efter pallsaldobesked via datumintervall. Byt ut följande mot aktuella värden: <Kundens_momsregistreringsnummer> <Användar_ID> <Användar_lösenord> <e_postadress> <Kundnummer>

15 Datum: Sida 15 av 20 tem.statistics.remote.send_data_format=hqf&system.statistics.remote.access_type=a&system.sta tistics.remote.application_name=test&system.statistics.user.organization_id=<kundens_momsre gistreringsnummer>&system.statistics.user.language_code=sv&system.statistics.user.return_mim e_format=xml&request.format.mime=text/xml&request.user.login_name=<användar_id>&request.user.password=<användar_lösenord>&request.admin.e_mail=<e_postadress>&request.service. action=select&request.service.method=search_pallet_balance&data_list.0.reference_type=date& data_list.0.start_date= &data_list.0.end_date= &data_list.0.customer_number=<Kundnummer> Exempel på sökning efter pallsaldobesked via fakturanummer. Byt ut följande mot aktuella värden: <Kundens_momsregistreringsnummer> <Användar_ID> <Användar_lösenord> <e_postadress> <Fakturanummer> tem.statistics.remote.send_data_format=hqf&system.statistics.remote.access_type=a&system.sta tistics.remote.application_name=test&system.statistics.user.organization_id=<kundens_momsre gistreringsnummer>&system.statistics.user.language_code=sv&system.statistics.user.return_mim e_format=xml&request.format.mime=text/xml&request.user.login_name=<användar_id>&request.user.password=<användar_lösenord>&request.admin.e_mail=<e_postadress>&request.service. action=select&request.service.method=search_pallet_balance&data_list.0.reference_type=iv&dat a_list.0.reference_number=<fakturanummer> 5.2 Response Information som returneras från tjänsten tillsammans med response-variablerna. Lägg till prefixet data_list.n. till variablerna, där n är ett index som startar på 0. customer_number String NAD DE 3039 office_name String NAD commercial_invoice_number String RFF DE IV DE 1154 pallet_balance_date String DTM Kundnummer Kontorsnummer Fakturanummer Datum när pallsaldobeskedet är utfärdat. pallet_balance_identification String FTX Pallsaldonummer pallet_balance_count CMT Saldo (Antal pallar)

16 Datum: Sida 16 av 20 Exempel på svar: <?xml version="1.0" encoding="iso "?> - <xml> - <response> <data_list_count>2</data_list_count> - <service> <name>invoicedoc</name> <version>1.0</version> </service> </response> - <system> - <error> <message>your request was successfully processed.</message> <id>0</id> </error> </system> - <data_list> - <data index="1"> <pallet_balance>oss tillgodo 264</pallet_balance> <commercial_invoice_number> </commercial_invoice_number> <office_name>stockholm</office_name> <pallet_balance_date> </pallet_balance_date> <customer_number> </customer_number> <pallet_balance_identification> </pallet_balance_identification> </data> - <data index="0"> <commercial_invoice_number> </commercial_invoice_number> <pallet_balance_date> </pallet_balance_date> <pallet_balance>oss tillgodo 210</pallet_balance> <customer_number> </customer_number> <office_name>stockholm</office_name> <pallet_balance_identification> </pallet_balance_identification> </data> </data_list> </xml>

17 Datum: Sida 17 av 20 6 Meddelandehämtning av pdf-faktura service.method = pdf_invoice 6.1 Request Information som skickas till tjänsten tillsammans med request-variablerna. Lägg till prefixet data_list.0. till variablerna. customer_number O String NAD commercial_invoice_number O String RFF DE IV DE 1154 invoice_date O String DTM Kundnummer Fakturanummer Datum när fakturan är utfärdad Exempel på hämtning av pdf-faktura. Byt ut följande mot aktuella värden: <Kundens_momsregistreringsnummer> <Användar_ID> <Användar_lösenord> <e_postadress> <Fakturanummer> <Kundnummer> tem.statistics.remote.send_data_format=hqf&system.statistics.remote.access_type=a&system.sta tistics.remote.application_name=test&system.statistics.user.organization_id=<kundens_momsre gistreringsnummer>&system.statistics.user.language_code=sv&system.statistics.user.return_mim e_format=xml&request.format.mime=text/xml&request.user.login_name=<användar_id>&request.user.password=<användar_lösenord>&request.service.method=pdf_invoice&request.service.acti on=select&request.admin.e_mail=<e_postadress>&data_list.0.commercial_invoice_number=<fak turanummer>&data_list.0.invoice_date= &data_list.0.customer_number=<Kundnummer> 6.2 Response En pdf returneras om sökningen ger träff. I annat fall returneras de generella variablerna.

18 Datum: Sida 18 av 20 7 Meddelandehämtning av pdf-debiteringsbesked service.method = pdf_debit 7.1 Request Information som skickas till tjänsten tillsammans med request-variablerna. Lägg till prefixet data_list.0. till variablerna. customer_number O String NAD DE 3039 office_name O String NAD DE 3036 accounting_period_start_date O String DTM debit_date O Date DTM invoice_total_monetary_amount O String MOA DE 5004 Kundnummer Kontorsnamn Konteringsperiodens startdatum = Date/time/period format code, code 4 = CCYYMMDD, example: Datum när debiteringsbeskedet är utfärdat. Saldobelopp Exempel på hämtning av pdf-debiteringsbesked. Byt ut följande mot aktuella värden: <Kundens_momsregistreringsnummer> <Användar_ID> <Användar_lösenord> <e_postadress> <Kundnummer> tem.statistics.remote.send_data_format=hqf&system.statistics.remote.access_type=a&system.sta tistics.remote.application_name=test&system.statistics.user.organization_id=<kundens_momsre gistreringsnummer>&system.statistics.user.language_code=sv&system.statistics.user.return_mim e_format=xml&request.format.mime=text/xml&request.user.login_name=<användar_id>&request.user.password=<användar_lösenord>&request.service.method=pdf_debit&request.service.action =select&request.admin.e_mail=<e_postadress>&data_list.0.debit_date= &data_list.0.accounting_period_start_date=

19 Datum: Sida 19 av 20 23&data_list.0.office_name=NYBRO&data_list.0.invoice_total_monetary_amount=12.816&data_li st.0.customer_number=<kundnummer> 7.2 Response En pdf returneras om sökningen ger träff. I annat fall returneras de generella variablerna.

20 Datum: Sida 20 av 20 8 Meddelandehämtning av pdf-pallsaldobesked service.method = pdf_pallet_balance 8.1 Request Information som skickas till tjänsten tillsammans med request-variablerna. Lägg till prefixet data_list.0. till variablerna. customer_number String NAD DE 3039 pallet_balance_date String DTM Kundnummer Datum när pallsaldobeskedet är utfärdat. pallet_balance_identification String FTX Pallsaldonummer Exempel på hämtning av pdf-pallsaldobesked. Byt ut följande mot aktuella värden: <Kundens_momsregistreringsnummer> <Användar_ID> <Användar_lösenord> <e_postadress> <Pallsaldonummer> <Kundnummer> tem.statistics.remote.send_data_format=hqf&system.statistics.remote.access_type=a&system.sta tistics.remote.application_name=test&system.statistics.user.organization_id=<kundens_momsre gistreringsnummer>&system.statistics.user.language_code=sv&system.statistics.user.return_mim e_format=xml&request.format.mime=text/xml&request.user.login_name=<användar_id>&request.user.password=<användar_lösenord>&request.service.method=pdf_pallet_balance&request.ser vice.action=select&request.admin.e_mail=<e_postadress>&data_list.0.pallet_balance_identificati on=<pallsaldonummer>&data_list.0.pallet_balance_date= &data_list.0.customer_number=<Kundnummer> 8.2 Response En pdf returneras om sökningen ger träff. I annat fall returneras de generella variablerna.